ant-design/components/collapse/index.en-US.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2016-07-04 10:51:50 +08:00
---
category: Components
type: Data Display
2016-07-04 10:51:50 +08:00
title: Collapse
cols: 1
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
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| accordion | If `true`, `Collapse` renders as `Accordion` | boolean | `false` |
2017-10-25 10:25:44 +08:00
| activeKey | Key of the active panel | string\[]\|string | No default value. In `accordion` mode, it's the key of the first panel. |
| bordered | Toggles rendering of the border around the collapse block | boolean | `true` |
2017-10-25 10:25:44 +08:00
| defaultActiveKey | Key of the initial active panel | string | - |
| onChange | Callback function executed when active panel is changed | Function | - |
| destroyInactivePanel | Destroy Inactive Panel | boolean | `false` |
2016-07-04 10:51:50 +08:00
### Collapse.Panel
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| disabled | If `true`, panel cannot be opened or closed | boolean | `false` |
2018-06-24 17:09:18 +08:00
| forceRender | Forced render of content on panel, instead of lazy rending after clicking on header | boolean | `false` |
2017-10-25 10:25:44 +08:00
| header | Title of the panel | string\|ReactNode | - |
| key | Unique key identifying the panel from among its siblings | string | - |
| showArrow | If `false`, panel will not show arrow icon | boolean | `true` |