Skip to content

Illuminate Documentation

Illuminate

Home

Accordions

Learn how to use the Accordion component in your documentation to organize supplemental content in expandable panels.



Overview

The Accordion component is an expandable block of content that is collapsed by default. This is useful for initially hiding supplemental information to improve the overall readability of a page. The Accordion component consists of a visible header with a title to summarize the content and a body that can contain any Markdown, media, or even other components. Readers can select the header to toggle the Accordion to show or hide the content in the body.


Properties

NameTypeDescription
title requiredstringTitle of the accordion panel.

Examples

Simple accordion

simple-accordion.mdx

<Accordion title="Select to expand this accordion">
This is an example of an accordion.
You can put any kind of Markdown inside of an accordion, such as a bulleted
list:
- item 1
- item 2
- item 3
Or a table:
| Column 1 | Column 2 | Column 3 |
| ---------- | -------------: | :------------: |
| some data | some more data | even more data |
| extra data | 893934 | something else |
</Accordion>


Keyboard support

KeyFunction
SpaceExpand or collapse the focused accordion.
EnterExpand or collapse the focused accordion.

Built with by