Accordions

Use the accordion component to show and hide content sections, organize related information, and enable progressive disclosure in your docs.

Accordions allow users to expand and collapse content sections. Use accordions for progressive disclosure and to organize information.

When you open an accordion, the URL hash updates, which lets you share direct links to specific accordion sections.

Single accordion

Accordion example

<Accordion title="I am an Accordion.">
  You can put any content in here, including other components, like code:

   ```java HelloWorld.java
    class HelloWorld {
        public static void main(String[] args) {
            System.out.println("Hello, World!");
        }
    }
  ```
</Accordion>

Accordion groups

Group related accordions together using <AccordionGroup>. This creates a cohesive section of accordions that can be individually expanded or collapsed.

Accordion Group Example

<AccordionGroup>
  <Accordion title="Getting started">
    You can put other components inside Accordions.

    ```java HelloWorld.java
    class HelloWorld {
        public static void main(String[] args) {
            System.out.println("Hello, World!");
        }
    }
    ```
  </Accordion>

  <Accordion title="Advanced features" icon="alien-8bit">
    Add icons to make accordions more visually distinct and scannable.
  </Accordion>

  <Accordion title="Troubleshooting">
    Keep related content organized into groups.
  </Accordion>
</AccordionGroup>

Properties

titlestringrequired

Title in the Accordion preview.

descriptionstring

Detail below the title in the Accordion preview.

defaultOpenbooleandefault: false

Whether the Accordion is open by default.

idstring

A custom ID for the accordion used for anchor linking. If omitted, defaults to the same value as title.

iconstring

The icon to display.

Options:

Font Awesome icon name, if you have the icons.library property set to fontawesome in your docs.json
Lucide icon name, if you have the icons.library property set to lucide in your docs.json
Tabler icon name, if you have the icons.library property set to tabler in your docs.json
URL to an externally hosted icon
Path to an icon file in your project
SVG code wrapped in curly braces

For custom SVG icons:

Convert your SVG using the SVGR converter.
Paste your SVG code into the SVG input field.
Copy the complete <svg>...</svg> element from the JSX output field.
Wrap the JSX-compatible SVG code in curly braces: icon={<svg ...> ... </svg>}.
Adjust height and width as needed.

iconTypestring

The Font Awesome icon style. Only used with Font Awesome icons.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

Single accordion

Accordion groups

Properties

On this page