Collapse
Collapse
A content area which can be collapsed and expanded.
Importimport { Collapse } from "antd"; |
Sourcecomponents/collapse |
- Components Overview
- General
- Layout
- Navigation
- Data Entry
- Data Display
- Feedback
- Other
Importimport { Collapse } from "antd"; |
Sourcecomponents/collapse |
Accordion is a special kind of Collapse, which allows only one panel to be expanded at a time.// works when >= 5.6.0, recommended ✅const text = `A dog is a type of domesticated animal.Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.`;const items: CollapseProps['items'] = [{key: '1',label: 'This is panel header 1',children: <p>{text}</p>,},{key: '2',label: 'This is panel header 2',children: <p>{text}</p>,},{key: '3',label: 'This is panel header 3',children: <p>{text}</p>,},];<Collapse items={items} defaultActiveKey={['1']} />;// works when <5.6.0 , deprecated when >=5.6.0 🙅🏻♀️<Collapse defaultActiveKey={['1']} onChange={onChange}><Panel header="This is panel header 1" key="1"><p>{text}</p></Panel><Panel header="This is panel header 2" key="2"><p>{text}</p></Panel><Panel header="This is panel header 3" key="3"><p>{text}</p></Panel></Collapse>;
Common props ref：Common props
| 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 how to trigger Collapse. Either by clicking icon or by clicking any area in header or disable collapse functionality itself | header | icon | disabled | - | 4.9.0 |
| defaultActiveKey | Key of the initial active panel | string[] | string number[] | number | - | |
| Destroy Inactive Panel | boolean | false | ||
| destroyOnHidden | Destroy Inactive Panel | boolean | false | 5.25.0 |
| 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 |
| size | Set the size of collapse | large | middle | small | middle | 5.2.0 |
| onChange | Callback function executed when active panel is changed | function | - | |
| items | collapse items content | ItemType | - | 5.6.0 |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| classNames | Semantic structure className | Record<header | body, string> | - | 5.21.0 |
| collapsible | Specify whether the panel be collapsible or the trigger area of collapsible | header | icon | disabled | - | |
| children | Body area content | ReactNode | - | |
| 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 | |
| key | Unique key identifying the panel from among its siblings | string | number | - | |
| label | Title of the panel | ReactNode | - | - |
| showArrow | If false, panel will not show arrow icon. If false, collapsible can't be set as icon | boolean | true | |
| styles | Semantic DOM style | Record<header | body, CSSProperties> | - | 5.21.0 |
When using version >= 5.6.0, we prefer to configuring the panel by items.
| 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 |
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| borderlessContentBg | Background of content in borderless style | string | transparent |
| borderlessContentPadding | Padding of content in borderless style | undefined | Padding<string | number> | 4px 16px 16px |
| contentBg | Background of content | string | #ffffff |
| contentPadding | Padding of content | undefined | Padding<string | number> | 16px 16px |
| headerBg | Background of header | string | rgba(0,0,0,0.02) |
| headerPadding | Padding of header | undefined | Padding<string | number> | 12px 16px |
By default, any number of panels can be expanded at a time. The first panel is expanded in this example.
Ant Design supports a default collapse size as well as a large and small size.
If a large or small collapse is desired, set the size property to either large or small respectively. Omit the size property for a collapse with the default size.
In accordion mode, only one panel can be expanded at a time.
Collapse is nested inside the Collapse.
A borderless style of Collapse.
Customize the background, border, margin styles and icon for each panel.
You can hide the arrow icon by passing showArrow={false} to CollapsePanel component.
Render extra element in the top-right corner of each panel.
Making collapse's background to transparent.
Specify the trigger area of collapsible by collapsible.
