Skip to content

Accordion API

API reference docs for the React Accordion component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import Accordion from '@mui/material/Accordion';
// or
import { Accordion } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Paper component are also available.

NameTypeDefaultDescription
children*node-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

defaultExpandedboolfalse

If true, expands the accordion by default.

disabledboolfalse

If true, the component is disabled.

disableGuttersboolfalse

If true, it removes the margin between two expanded accordion items and the increase of height.

expandedbool-

If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.

onChangefunc-

Callback fired when the expand/collapse state is changed.

Signature:function(event: React.SyntheticEvent, expanded: boolean) => void
  • event The event source of the callback. Warning: This is a generic event not a change event.
  • expanded The expanded state of the accordion.
slotProps{ heading?: func
| object, transition?: func
| object }
{}

The props used for each slot inside.

slots{ heading?: elementType, transition?: elementType }{}

The components used for each slot inside.

squareboolfalse

If true, rounded corners are disabled.

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

TransitionComponentelementType-

The component used for the transition. Follow this guide to learn more about the requirements for this component.

TransitionPropsobject-

Props applied to the transition element. By default, the element is based on this Transition component.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Paper component are also available in Accordion. You can take advantage of this to target nested components.

Theme default props

You can use MuiAccordion to change the default props of this component with the theme.

Slots

Slot nameClass nameDefault componentDescription
heading.MuiAccordion-heading'h3'The component that renders the heading.
transitionCollapseThe component that renders the transition. Follow this guide to learn more about the requirements for this component.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-expandedState class applied to the root element if expanded={true}.
.MuiAccordion-guttersguttersStyles applied to the root element unless disableGutters={true}.
.MuiAccordion-regionregionStyles applied to the region element, the container of the children.
.MuiAccordion-rootrootStyles applied to the root element.
.MuiAccordion-roundedroundedStyles applied to the root element unless square={true}.

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.