The Accordion plugin creates collapsible content sections. Each item has a heading (click to expand/collapse) and content area. It uses native <details> / <summary> in the default render and supports HTML serialization from those elements.
Installation
npm install @yoopta/accordion
Basic Usage
Pass the plugin to createYooptaEditor; do not pass plugins to <YooptaEditor>.
import { useMemo } from 'react';import YooptaEditor, { createYooptaEditor } from '@yoopta/editor';import Accordion from '@yoopta/accordion';const plugins = [Accordion];export default function Editor() { const editor = useMemo(() => createYooptaEditor({ plugins, marks: [] }), []); return <YooptaEditor editor={editor} onChange={() => {}} />;}
Features
Expand/Collapse: Each item can be expanded or collapsed via isExpanded prop
Keyboard: Enter toggles expansion when in heading, or inserts a new item; Backspace removes empty items or the block
HTML: Deserializes from <details> / <summary> / <p>; serializes to the same
Email: Serializes to table-based layout for email clients
import Accordion from '@yoopta/accordion';const plugins = [Accordion];
Options
object
Show properties
string
default:"Accordion"
Display title in UI menus
string
default:"Create collapses"
Description shown in menus
string[]
default:"['accordion']"
Keyboard shortcuts to trigger the plugin in slash menu
Element props
object
Show properties
boolean
default:"true"
Whether the accordion item is expanded (open) or collapsed
Commands
Accordion commands are available via the plugin’s commands and through the editor. Use the Blocks namespace from @yoopta/editor for generic block operations (insert, delete, update meta) and Accordion commands for accordion structure.
Deserialize: <details> with <summary> and <p> children
Serialize: Accordion block → <div> containing <details> / <summary> / <p>; block meta align and depth are stored in data-meta-align and data-meta-depth on each <details>
Email
Serialize: Table-based layout for compatibility with email clients; headings and content in table rows with inline styles.