2016-07-04 10:51:50 +08:00
---
category: Components
2016-11-09 14:43:32 +08:00
type: Data Display
2016-07-04 10:51:50 +08:00
title: Collapse
2016-11-06 15:06:34 +08:00
cols: 1
2020-05-31 11:48:34 +08:00
cover: https://gw.alipayobjects.com/zos/alicdn/IxH16B9RD/Collapse.svg
2016-07-04 10:51:50 +08:00
---
A content area which can be collapsed and expanded.
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-04 10:51:50 +08:00
- Can be used to group or hide complex regions to keep the page clean.
- `Accordion` is a special kind of `Collapse` , which allows only one panel to be expanded at a time.
## API
### Collapse
2019-05-06 12:04:39 +08:00
| Property | Description | Type | Default | Version |
2019-05-07 14:57:32 +08:00
| --- | --- | --- | --- | --- |
2019-07-13 10:31:56 +08:00
| activeKey | Key of the active panel | string\[]\|string\| number\[]\|number | No default value. In `accordion` mode, it's the key of the first panel. | |
| defaultActiveKey | Key of the initial active panel | string\[]\|string\| number\[]\|number | - | |
2019-11-20 20:31:43 +08:00
| bordered | Toggles rendering of the border around the collapse block | boolean | `true` | |
| accordion | If `true` , `Collapse` renders as `Accordion` | boolean | `false` | |
2019-05-07 14:57:32 +08:00
| onChange | Callback function executed when active panel is changed | Function | - | |
2019-11-20 20:31:43 +08:00
| expandIcon | allow to customize collapse icon | (panelProps) => ReactNode | - | |
2020-01-17 17:23:48 +08:00
| expandIconPosition | Set expand icon position | `left` \| `right` | - | |
2019-11-20 20:31:43 +08:00
| destroyInactivePanel | Destroy Inactive Panel | boolean | `false` | |
2020-06-05 13:42:46 +08:00
| ghost | make the collapse borderless and its background transparent | boolean | `false` | 4.4.0 |
2016-07-04 10:51:50 +08:00
### Collapse.Panel
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| disabled | If `true` , panel cannot be opened or closed | boolean | `false` | |
2019-11-20 20:31:43 +08:00
| forceRender | Forced render of content on panel, instead of lazy rending after clicking on header | boolean | `false` | |
2019-07-11 14:14:33 +08:00
| header | Title of the panel | string\|ReactNode | - | |
2019-07-13 10:31:56 +08:00
| key | Unique key identifying the panel from among its siblings | string\|number | - | |
2019-11-20 20:31:43 +08:00
| showArrow | If `false` , panel will not show arrow icon | boolean | `true` | |
| extra | extra element in the corner | ReactNode | - | |
2020-06-05 13:42:46 +08:00
< style >
[data-theme="dark"] .site-collapse-ghost-wrapper {
background: rgba(255, 255, 255, 0.08);
}
< / style >
