Accordion

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#

AccordionItem Props#

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.

Theming#

The Accordion component is a multipart component. The styling needs to be applied to each part specifically.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

• A: root
• B: container
• C: button
• D: panel
• E: icon

Theming utilities#

• createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
• definePartsStyle: a function used to create multipart style objects.
• defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

import { accordionAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(accordionAnatomy.keys)

Customizing the default theme#

import { accordionAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(accordionAnatomy.keys)

const baseStyle = definePartsStyle({
  // define the part you're going to style
  container: {
    bg: 'red.200', // change the backgroundColor of the container
  },
})

export const accordionTheme = defineMultiStyleConfig({ baseStyle })

After customizing the accordion theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { accordionTheme } from './components/accordion'

export const theme = extendTheme({
  components: { Accordion: accordionTheme },
})

This is a crucial step to make sure that any changes that we make to the accordion theme are applied.

Adding a custom size#

Let's assume we want to include an extra large accordion icon size. Here's how we can do that:

import { accordionAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(accordionAnatomy.keys)

const xl = defineStyle({
  fontSize: 'lg',
  px: '4',
  h: '12',
})

const sizes = {
  xl: definePartsStyle({ icon: xl }),
}

export const accordionTheme = defineMultiStyleConfig({ sizes })

// Now we can use the new `xl` size
<Accordion size="xl"> ... </Accordion>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom pill variant. Here's how we can do that:

import { accordionAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(accordionAnatomy.keys)

const custom = definePartsStyle({
  panel: {
    border: '1px solid',
    borderColor: 'gray.200',
    background: 'gray.50',
    borderRadius: 'full',

    // Let's also provide dark mode alternatives
    _dark: {
      borderColor: 'gray.600',
      background: 'gray.800',
    },
  },
  icon: {
    border: '1px solid',
    borderColor: 'gray.200',
    background: 'gray.200',
    borderRadius: 'full',
    color: 'gray.500',

    _dark: {
      borderColor: 'gray.600',
      background: 'gray.600',
      color: 'gray.400',
    },
  },
})

export const accordionTheme = defineMultiStyleConfig({
  variants: { custom },
})

// Now we can use the new `custom` variant
<Accordion variant="custom"> ... </Accordion>

Changing the default properties#

Let's assume we want to change the default size and variant of every accordion in our app. Here's how we can do that:

import { accordionAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(
  accordionAnatomy.keys,
)

export const accordionTheme = defineMultiStyleConfig({
  defaultProps: {
    size: 'xl',
    variant: 'custom',
  },
})

// This saves you time, instead of manually setting the size and
// variant every time you use an accordion:
<Accordion size="xl" variant="custom"> ... </Accordion>

Showcase#

import {
  Box,
  useColorMode,
  Accordion,
  AccordionButton,
  AccordionIcon,
  AccordionItem,
  AccordionPanel,
  IconButton,
} from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();

  return (
    <Box pt={12} position="relative" h="100vh">
      <Accordion>
        <AccordionItem m={4}>
          <h2>
            <AccordionButton>
              <Box flex="1" textAlign="left">
                Section 1 title
              </Box>
              <AccordionIcon />
            </AccordionButton>
          </h2>
          <AccordionPanel pb={4}>
            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
            eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
            ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
            aliquip ex ea commodo consequat.
          </AccordionPanel>
        </AccordionItem>

        <AccordionItem m={4}>
          <h2>
            <AccordionButton>
              <Box flex="1" textAlign="left">
                Section 2 title
              </Box>
              <AccordionIcon />
            </AccordionButton>
          </h2>
          <AccordionPanel pb={4}>
            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
            eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
            ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
            aliquip ex ea commodo consequat.
          </AccordionPanel>
        </AccordionItem>
      </Accordion>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode}
        icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}