Skip to content

Collapse API

API reference docs for the React Collapse 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 Collapse from '@mui/material/Collapse';
// or
import { Collapse } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

The Collapse transition is used by the Vertical Stepper StepContent component. It uses react-transition-group internally.

Props

Props of the Transition component are also available.

addEndListener

children

classes

collapsedSize

component

easing

in

orientation

sx

timeout

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Transition component from react-transition-group are also available in Collapse. You can take advantage of this to target nested components.


Theme default props

You can use MuiCollapse 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.

.MuiCollapse-root

.MuiCollapse-horizontal

.MuiCollapse-entered

.MuiCollapse-hidden

.MuiCollapse-wrapper

.MuiCollapse-wrapperInner


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