Skip to main content

Accordion

Accordions display a list of high-level options that can expand/collapse to reveal more information.

Import

Chakra UI exports 5 accordion-related components.

  • Accordion: The wrapper that uses cloneElement to pass props to AccordionItem children.
  • AccordionItem: A single accordion item.
  • AccordionButton: The button that toggles the expand/collapse state of the accordion item. This button must be wrapped in an element with role heading.
  • AccordionPanel: The container for the details to be revealed.
  • AccordionIcon: A chevron-down icon that rotates based on the expanded/collapsed state
import {
Accordion,
AccordionItem,
AccordionButton,
AccordionPanel,
AccordionIcon,
} from '@chakra-ui/react';

Usage

By default, only one item may be expanded and it can only be collapsed again by expanding another.

Accordion now supports keyboard navigation between accordion buttons. Pressing the up and down arrow keys will move focus between accordion buttons.

Expand multiple items at once

If you set allowMultiple to true then the accordion will permit multiple items to be expanded at once.

If you pass this prop, ensure that the index or defaultIndex prop is an array.

Toggle each accordion item

If you set allowToggle to true, any expanded item may be collapsed again.

Styling the expanded state

The AccordionButton component has aria-expanded set to true or false depending on the state of the AccordionItem. Use the style prop _expanded to style this state.

Accessing the internal state

If you need access to the internal state of each accordion item, you can use a render prop. It provides 2 internal state props: isExpanded and isDisabled.

Accessibility

Pressing space or enter when focus is on the accordion panel header will toggle (expand or collapse) the accordion.

Props

Accordion Props

allowMultiple

Description

If true, multiple accordion items can be expanded at once.

Type
boolean

allowToggle

Description

If true, any expanded accordion item can be collapsed again.

Type
boolean

colorScheme

Description

Color Schemes for Accordion are not implemented in the default theme. You can extend the theme to implement them.

Type
string

defaultIndex

Description

The initial index(es) of the expanded accordion item

Type
ExpandedIndex

index

Description

The index(es) of the expanded accordion item

Type
ExpandedIndex

onChange

Description

The callback invoked when accordion items are expanded or collapsed.

Type
((expandedIndex: ExpandedIndex) => void)

reduceMotion

Description

If true, height animation and transitions will be disabled.

Type
boolean

size

Description

Sizes for Accordion are not implemented in the default theme. You can extend the theme to implement them.

Type
string

variant

Description

Variants for Accordion are not implemented in the default theme. You can extend the theme to implement them.

Type
string

AccordionItem Props

id

Description

A unique id for the accordion item.

Type
string

isDisabled

Description

If true, the accordion item will be disabled.

Type
boolean

isFocusable

Description

If true, the accordion item will be focusable.

Type
boolean

AccordionButton Props

AccordionButton renders a button and composes Box, this means you can style it by passing the pseudo style props _expanded, _disabled, _hover, etc.

AccordionPanel Props

AccordionPanel renders a div and composes Collapse to provide the height animation.