Skip to content
Edit this page

Accordion API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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.

childrenRequired

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
defaultExpanded

If true, expands the accordion by default.

Type:

bool

Default:

false
disabled

If true, the component is disabled.

Type:

bool

Default:

false
disableGutters

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

Type:

bool

Default:

false
expanded

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

Type:

bool
onChange

Callback fired when the expand/collapse state is changed.

Type:

func

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.
square

If true, rounded corners are disabled.

Type:

bool

Default:

false
sx

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

Type:

Array<func | object | bool> | func | object
TransitionComponent

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

Type:

elementType

Default:

Collapse
TransitionProps

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

Type:

object
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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiAccordion-rootroot

Styles applied to the root element.

.MuiAccordion-roundedrounded

Styles applied to the root element unless square={true}.

.Mui-expandedexpandedSTATE

State class applied to the root element if expanded={true}.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.MuiAccordion-guttersgutters

Styles applied to the root element unless disableGutters={true}.

.MuiAccordion-regionregion

Styles applied to the region element, the container of the children.

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