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

32 lines
1.1 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
| Property | Description | Type | Default |
|----------|----------------|----------|--------------|
| activeKey | key of the active panel | string[]\|string | No default value. In `accordion` mode, it's the key of the first panel. |
| defaultActiveKey | key of the initialized active panel | string | - |
2016-07-04 10:51:50 +08:00
| onChange | a callback function, which can be executed when you switch the panels | Function | - |
### Collapse.Panel
| Property | Description | Type | Default |
|----------|----------------|----------|--------------|
| key | corresponds to the `activeKey` | string | - |
| header | title of the panel | string\|ReactNode | - |
| disabled | users cannot change opening status of a disabled panel | boolean | false |