ant-design/components/collapse/index.en-US.md
07akioni c2beed8bd3
feat: add ghost prop for collapse (#24734)
* feat: add ghost prop for collapse

* doc: version of collapse's ghost prop

* refactor: make ghost collapse's less code to a nested style

* chore: remove redundant codes in ghost collapse's less & doc

* doc: add a background wrapper for ghost collapse demo

* doc: dark-theme wrapper bg-color for ghost collapse demo

* test: update snapshot of ghost collapse

* doc: use softer bg-color on ghost collapse demo

* doc: remove disabled panel in ghost collapse demo
2020-06-05 13:42:46 +08:00

2.0 KiB

category type title cols cover
Components Data Display Collapse 1 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 of Collapse, which allows only one panel to be expanded at a time.

API

Collapse

Property Description Type Default Version
activeKey Key of the active panel string[]|string| number[]|number No default value. In accordion mode, it's the key of the first panel.
defaultActiveKey Key of the initial active panel string[]|string| number[]|number -
bordered Toggles rendering of the border around the collapse block boolean true
accordion If true, Collapse renders as Accordion boolean false
onChange Callback function executed when active panel is changed Function -
expandIcon allow to customize collapse icon (panelProps) => ReactNode -
expandIconPosition Set expand icon position left | right -
destroyInactivePanel Destroy Inactive Panel boolean false
ghost make the collapse borderless and its background transparent boolean false 4.4.0

Collapse.Panel

Property Description Type Default Version
disabled If true, panel cannot be opened or closed boolean false
forceRender Forced render of content on panel, instead of lazy rending after clicking on header boolean false
header Title of the panel string|ReactNode -
key Unique key identifying the panel from among its siblings string|number -
showArrow If false, panel will not show arrow icon boolean true
extra extra element in the corner ReactNode -