Accordions

Use Mintlify-style accordions to group optional details without interrupting the main implementation path.

Accordions keep secondary information available without forcing every reader through it. Use them for grouped questions, troubleshooting branches, and optional implementation notes.

Use accordions after the main path

If the detail changes the required setup flow, keep it visible in the article. If it helps only some readers, put it in an accordion.

Single accordion

You can put any content in here, including other components, like code:

class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
<Accordion title="I am an Accordion.">
  You can put any content in here, including other components, like code:

```java title="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.

You can put other components inside Accordions.

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

Add icons to make accordions more visually distinct and scannable.

Keep related content organized into groups.

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

```java title="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>

When an accordion opens, the URL hash updates. Use id for stable anchors and defaultOpen when imported docs need one item open on first render.

<Accordion title="Can accordions link directly?" id="accordion-direct-link" icon="link" defaultOpen>
  Yes. Accordions can receive stable IDs so support notes and related docs can link to a specific answer.
</Accordion>

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. Plandalf accepts common Mintlify icon names, Lucide names, library-prefixed names such as lucide:chevron-down, image paths, and inline SVG strings.

iconTypestring

Imported icon style metadata, such as regular, solid, light, thin, duotone, or brands. Plandalf preserves this metadata and maps supported icons through the shared docs icon layer.

Feature detail