跳转到内容

Collapse API

想要学习更多组件属性和 CSS API,可以查阅 React Collapse 组件的 API 文档。

演示项目

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

导入

import Collapse from '@mui/material/Collapse';
// 或
import { Collapse } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

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

组件名称

在主题中,名称“MuiCollapse”可用于提供默认属性(props),或者样式覆盖

属性

Transition 组件的属性也是可用的。

名称类型默认值描述
addEndListenerfunc
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.
childrennode
The content node to be collapsed.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
collapsedSizenumber
| string
'0px'
The width (horizontal) or height (vertical) of the container when collapsed.
componentelement type
The component used for the root node. Either a string to use a HTML element or a component.
⚠️ Needs to be able to hold a ref.
easing{ enter?: string, exit?: string }
| string
The transition timing function. You may specify a single easing or a object containing enter and exit values.
inboolfalse
If true, the component will transition in.
orientation'horizontal'
| 'vertical'
'vertical'
The collapse transition orientation.
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.
timeout'auto'
| number
| { appear?: number, enter?: number, exit?: number }
duration.standard
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.

ref 则会被传递到根元素中。

继承

尽管上文没有明文记录, Transition 组件来自 react-transition-group 的属性(props) 在组件Collapse上同样是可用的。 你可以利用这一点来 指向嵌套组件

CSS

规则名称全局类名描述
root.MuiCollapse-rootStyles applied to the root element.
horizontal.MuiCollapse-horizontalPseudo-class applied to the root element if orientation="horizontal".
entered.MuiCollapse-enteredStyles applied to the root element when the transition has entered.
hidden.MuiCollapse-hiddenStyles applied to the root element when the transition has exited and collapsedSize = 0px.
wrapper.MuiCollapse-wrapperStyles applied to the outer wrapper element.
wrapperInner.MuiCollapse-wrapperInnerStyles applied to the inner wrapper element.

您可以使用组件自定义选项对组件进行个性化: