mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 05:29:37 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
2.6 KiB
2.6 KiB
category | group | title | cover |
---|---|---|---|
Components | Data Display | Collapse | https://gw.alipayobjects.com/zos/alicdn/IxH16B9RD/Collapse.svg |
A content area which can be collapsed and expanded.
When To Use
- Can be used to group or hide complex regions to keep the page clean.
Accordion
is a special kind ofCollapse
, which allows only one panel to be expanded at a time.
Examples
Collapse
Accordion
Nested panel
Borderless
Custom Panel
No arrow
Extra node
Ghost Collapse
Collapsible
API
Collapse
Property | Description | Type | Default | Version |
---|---|---|---|---|
accordion | If true, Collapse renders as Accordion | boolean | false | |
activeKey | Key of the active panel | string[] | string number[] | number |
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 | |
collapsible | Specify whether the panels of children be collapsible or the trigger area of collapsible | header | icon | disabled |
- | 4.9.0 |
defaultActiveKey | Key of the initial active panel | string[] | string number[] | number |
- | |
destroyInactivePanel | Destroy Inactive Panel | boolean | false | |
expandIcon | Allow to customize collapse icon | (panelProps) => ReactNode | - | |
expandIconPosition | Set expand icon position | start | end |
- | 4.21.0 |
ghost | Make the collapse borderless and its background transparent | boolean | false | 4.4.0 |
onChange | Callback function executed when active panel is changed | function | - |
Collapse.Panel
Property | Description | Type | Default | Version |
---|---|---|---|---|
collapsible | Specify whether the panel be collapsible or the trigger area of collapsible | header | icon | disabled |
- | 4.9.0 (icon: 4.24.0) |
extra | The extra element in the corner | ReactNode | - | |
forceRender | Forced render of content on panel, instead of lazy rendering after clicking on header | boolean | false | |
header | Title of the panel | ReactNode | - | |
key | Unique key identifying the panel from among its siblings | string | number | - | |
showArrow | If false, panel will not show arrow icon. If false, collapsible can't be set as icon | boolean | true |