Accordions
The Accordion block is a dynamic and interactive way to present content in your documentation. It allows you to organize information into collapsible sections, making it easier for users to navigate and find what they need—without overwhelming them with too much text at once.
Use this feature to create concise, collapsible sections in your documentation.
Structure of an Accordion Item
Each accordion item consists of two main components:
- Title: A clear, concise text title that indicates the topic or subject of the accordion item. This title serves as a clickable header that users can interact with to expand or collapse the content.
- Body: The body of the accordion item is fully formatable, allowing you to use various text formatting features, such as lists, links, and other rich content. This flexibility ensures that your accordion items are informative and engaging, making it easy to present complex information in a structured way.
How to Add an Accordion
Multiple items Accordion
You can easily add new accordion items by selecting the menu within the accordion. The "Add Accordion Item" option lets you place another item within the same accordion group, enabling you to expand your content without cluttering the page. This feature is particularly useful for organizing related information under a single topic, providing a clean and structured layout.
By hovering over or selecting an accordion item, you can control its position within the group using the edit icon on the right. Rearranging items is as easy as dragging them to their new position.
Accordion Modes
Once your accordion contains more than one item, you can customize its behavior with two modes:
Open One at a Time
Selecting this option ensures that only one accordion item can be open at a time. When a user expands a new item, any previously opened item will automatically collapse. This mode is ideal for guiding users through a linear flow of information, ensuring they focus on one section at a time.
Either this is expanded Or this one
Allow Multiple Open
This option enables users to expand multiple accordion items simultaneously. It's perfect for situations where users may need to view several sections of content at once, providing them with more flexibility and control over the information.
You can expand this Or you can expand that We act independently of each other