Collapse

When To Use

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.

Examples

<code src="./demo/basic.tsx">Collapse</code> <code src="./demo/size.tsx">Size</code> <code src="./demo/accordion.tsx">Accordion</code> <code src="./demo/mix.tsx">Nested panel</code> <code src="./demo/borderless.tsx">Borderless</code> <code src="./demo/custom.tsx">Custom Panel</code> <code src="./demo/noarrow.tsx">No arrow</code> <code src="./demo/extra.tsx">Extra node</code> <code src="./demo/ghost.tsx">Ghost Collapse</code> <code src="./demo/collapsible.tsx">Collapsible</code> <code src="./demo/style-class.tsx" version="6.0.0">Custom semantic dom styling</code> <code src="./demo/component-token.tsx" debug>Component Token</code>

API

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
classNames	Customize class for each semantic structure inside the component. Supports object or function.	Record<SemanticDOM, string> \| (info: { props })=> Record<SemanticDOM, string>	-
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	-
~~destroyInactivePanel~~	Destroy Inactive Panel	boolean	false
destroyOnHidden	Destroy Inactive Panel	boolean	false	5.25.0
expandIcon	Allow to customize collapse icon	(panelProps) => ReactNode	-
expandIconPlacement	Set expand icon placement	`start` \| `end`	`start`	-
~~expandIconPosition~~	Set expand icon position, Please use `expandIconPlacement` instead	`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` \| `medium` \| `small`	`medium`	5.2.0
styles	Customize inline style for each semantic structure inside the component. Supports object or function.	Record<SemanticDOM, CSSProperties> \| (info: { props })=> Record<SemanticDOM, CSSProperties>	-
onChange	Callback function executed when active panel is changed	function	-
items	collapse items content	ItemType	-	5.6.0

ItemType

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

Collapse.Panel

:::warning{title=Deprecated} 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

Semantic DOM

Design Token