Skip to content
Edit this page

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

Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.

Type:

func
children

The content node to be collapsed.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
collapsedSize

The width (horizontal) or height (vertical) of the container when collapsed.

Type:

number | string

Default:

'0px'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

element type
easing

The transition timing function. You may specify a single easing or a object containing enter and exit values.

Type:

{ enter?: string, exit?: string } | string
in

If true, the component will transition in.

Type:

bool
orientation

The transition orientation.

Type:

'horizontal' | 'vertical'

Default:

'vertical'
sx

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

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
timeout

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
Set to 'auto' to automatically calculate transition time based on height.

Type:

'auto' | number | { appear?: number, enter?: number, exit?: number }

Default:

duration.standard
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-rootroot

Styles applied to the root element.

.MuiCollapse-horizontalhorizontal

State class applied to the root element if orientation="horizontal".

.MuiCollapse-enteredentered

Styles applied to the root element when the transition has entered.

.MuiCollapse-hiddenhidden

Styles applied to the root element when the transition has exited and collapsedSize = 0px.

.MuiCollapse-wrapperwrapper

Styles applied to the outer wrapper element.

.MuiCollapse-wrapperInnerwrapperInner

Styles applied to the inner wrapper element.

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