Accordion

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

Props#

Accordion.Root Props#

`collapsible`

Description

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

Type

boolean

Default

false

`defaultIndex`

Description

The initial index(es) of the expanded accordion item

Type

number | number[]

`index`

Description

The index(es) of the expanded accordion item

Type

number | number[]

`multiple`

Description

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

Type

boolean

Default

false

`onChange`

Description

The callback invoked when accordion items are expanded or collapsed.

Type

(expandedIndex: number | number[]) => void

`reduceMotion`

Description

If true, height animation and transitions will be disabled.

Type

boolean

Default

false

Accordion.Item Props#

`id`

Description

A unique id for the accordion item.

Type

string

`isDisabled`

Description

If true, the accordion item will be disabled.

Type

boolean

Default

false

`isFocusable`

Description

If true, the accordion item will be focusable.

Type

boolean

Default

false

Accordion.Trigger Props#

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

Accordion.Content Props#

Accordion.Content 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: root
C: trigger
D: content
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.Root size="xl"> ... </Accordion.Root>

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.Root variant="custom"> ... </Accordion.Root>

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.Root size="xl" variant="custom"> ... </Accordion.Root>

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>
  );
}

Edit this page on GitHub