Jamdesk Documentation logo

Accordion

Seções recolhíveis que os leitores expandem para ver detalhes. Use-as em FAQs, listas de recursos e opções de configuração.

Accordions são seções recolhíveis. Os leitores veem o título e o expandem para ver os detalhes. Um accordion pode receber um ícone e uma descrição. Você também pode agrupar accordions.

Use Accordions quando:

  • FAQs: os leitores escaneiam as perguntas e expandem as respostas
  • Listas de recursos: cada recurso recebe uma seção com detalhes
  • Opções de configuração: agrupe as configurações por categoria
  • Guias passo a passo com detalhes expansíveis

Uso

<Accordion title="Advanced Configuration">

  Optional details go here.

</Accordion>

Acordeão básico

Este conteúdo fica oculto até que o accordion seja expandido.

Você pode incluir qualquer conteúdo aqui: texto, código, imagens ou outros componentes.

<Accordion title="Click to expand">

  This content is hidden until the accordion is expanded.

  You can include any content here: text, code, images, or other components.

</Accordion>

Com descrição

Adicione um subtítulo com a propriedade description:

Documentation for authentication API endpoints goes here.

<Accordion title="API Reference" description="Authentication endpoints">

  Documentation for authentication API endpoints goes here.

</Accordion>

Aberto por padrão

Comece expandido com defaultOpen:

This accordion starts in the open state.

<Accordion title="Already Expanded" defaultOpen>

  This accordion starts in the open state.

</Accordion>

Com ícone

Configuration options and settings.

<Accordion title="Settings" icon="gear">

  Configuration options and settings.

</Accordion>

Accordion vs Expandable

FeatureAccordionExpandable
IconsYesNo
DescriptionsYes (subtitle)No
GroupingAccordionGroupStandalone
Visual weightHeavier, section-likeLighter, inline
Best forFAQs, feature listsSupplementary content

Regra prática: Use Accordion quando as seções têm a mesma importância e os leitores escolhem entre elas. Use Expandable para detalhes "bons de ter" que não precisam de destaque visual.

Props

stringrequired

Texto do cabeçalho do accordion.

string

Subtítulo exibido abaixo do título.

string

Nome do ícone Font Awesome (por exemplo, "gear", "settings").

stringdefault: light

Variante de estilo do ícone: light, regular ou solid.

booleandefault: false

Começa no estado expandido.

O que vem a seguir?

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX