Collapse折叠面板

可以折叠/展开的内容区域。

何时使用

对复杂区域进行分组和隐藏，保持页面的整洁。
手风琴 是一种特殊的折叠面板，只允许单个内容区域展开。

代码演示

This is panel header 1

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.

This is panel header 2

This is panel header 3

折叠面板

可以同时展开多个面板，这个例子默认展开了第一个。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => {
  const onChange = (key: string | string[]) => {
    console.log(key);
  };

  return (
    <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>
  );
};

export default App;

Default Size

This is default size panel header

Small Size

This is small size panel header

Large Size

This is large size panel header

面板尺寸

折叠面板有大、中、小三种尺寸。

通过设置 size 为 large small 分别把折叠面板设为大、小尺寸。若不设置 size，则尺寸为中。

TypeScript
JavaScript
import React from 'react';
import { Collapse, Divider } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => (
  <>
    <Divider orientation="left">Default Size</Divider>
    <Collapse>
      <Panel header="This is default size panel header" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
    <Divider orientation="left">Small Size</Divider>
    <Collapse size="small">
      <Panel header="This is small size panel header" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
    <Divider orientation="left">Large Size</Divider>
    <Collapse size="large">
      <Panel header="This is large size panel header" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
  </>
);

export default App;

This is panel header 1

This is panel header 2

This is panel header 3

手风琴

手风琴，每次只打开一个 tab。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => (
  <Collapse accordion>
    <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>
);

export default App;

This is panel header 1

This is panel header 2

This is panel header 3

面板嵌套

嵌套折叠面板。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => {
  const onChange = (key: string | string[]) => {
    console.log(key);
  };

  return (
    <Collapse onChange={onChange}>
      <Panel header="This is panel header 1" key="1">
        <Collapse defaultActiveKey="1">
          <Panel header="This is panel nest panel" key="1">
            <p>{text}</p>
          </Panel>
        </Collapse>
      </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>
  );
};

export default App;

This is panel header 1

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.

This is panel header 2

This is panel header 3

简洁风格

一套没有边框的简洁样式。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

const text = (
  <p style={{ paddingLeft: 24 }}>
    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.
  </p>
);

const App: React.FC = () => (
  <Collapse bordered={false} defaultActiveKey={['1']}>
    <Panel header="This is panel header 1" key="1">
      {text}
    </Panel>
    <Panel header="This is panel header 2" key="2">
      {text}
    </Panel>
    <Panel header="This is panel header 3" key="3">
      {text}
    </Panel>
  </Collapse>
);

export default App;

This is panel header 1

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.

This is panel header 2

This is panel header 3

自定义面板

自定义各个面板的背景色、圆角、边距和图标。

TypeScript
JavaScript
import React from 'react';
import { CaretRightOutlined } from '@ant-design/icons';
import { Collapse, theme } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => {
  const { token } = theme.useToken();

  const panelStyle = {
    marginBottom: 24,
    background: token.colorFillAlter,
    borderRadius: token.borderRadiusLG,
    border: 'none',
  };

  return (
    <Collapse
      bordered={false}
      defaultActiveKey={['1']}
      expandIcon={({ isActive }) => <CaretRightOutlined rotate={isActive ? 90 : 0} />}
      style={{ background: token.colorBgContainer }}
    >
      <Panel header="This is panel header 1" key="1" style={panelStyle}>
        <p>{text}</p>
      </Panel>
      <Panel header="This is panel header 2" key="2" style={panelStyle}>
        <p>{text}</p>
      </Panel>
      <Panel header="This is panel header 3" key="3" style={panelStyle}>
        <p>{text}</p>
      </Panel>
    </Collapse>
  );
};

export default App;

This is panel header with arrow icon

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.

This is panel header with no arrow icon

隐藏箭头

你可以通过 showArrow={false} 隐藏 CollapsePanel 组件的箭头图标。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => {
  const onChange = (key: string | string[]) => {
    console.log(key);
  };

  return (
    <Collapse defaultActiveKey={['1']} onChange={onChange}>
      <Panel header="This is panel header with arrow icon" key="1">
        <p>{text}</p>
      </Panel>
      <Panel showArrow={false} header="This is panel header with no arrow icon" key="2">
        <p>{text}</p>
      </Panel>
    </Collapse>
  );
};

export default App;

This is panel header 1

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.

This is panel header 2

This is panel header 3

Expand Icon Position:

start

额外节点

可以同时展开多个面板，这个例子默认展开了第一个。

TypeScript
JavaScript
import React, { useState } from 'react';
import { SettingOutlined } from '@ant-design/icons';
import { Collapse, Select } from 'antd';

const { Panel } = Collapse;
const { Option } = Select;

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.
`;

type ExpandIconPosition = 'start' | 'end';

const App: React.FC = () => {
  const [expandIconPosition, setExpandIconPosition] = useState<ExpandIconPosition>('start');

  const onPositionChange = (newExpandIconPosition: ExpandIconPosition) => {
    setExpandIconPosition(newExpandIconPosition);
  };

  const onChange = (key: string | string[]) => {
    console.log(key);
  };

  const genExtra = () => (
    <SettingOutlined
      onClick={(event) => {
        // If you don't want click extra trigger collapse, you can prevent this:
        event.stopPropagation();
      }}
    />
  );

  return (
    <>
      <Collapse
        defaultActiveKey={['1']}
        onChange={onChange}
        expandIconPosition={expandIconPosition}
      >
        <Panel header="This is panel header 1" key="1" extra={genExtra()}>
          <div>{text}</div>
        </Panel>
        <Panel header="This is panel header 2" key="2" extra={genExtra()}>
          <div>{text}</div>
        </Panel>
        <Panel header="This is panel header 3" key="3" extra={genExtra()}>
          <div>{text}</div>
        </Panel>
      </Collapse>
      <br />
      <span>Expand Icon Position: </span>
      <Select value={expandIconPosition} style={{ margin: '0 8px' }} onChange={onPositionChange}>
        <Option value="start">start</Option>
        <Option value="end">end</Option>
      </Select>
    </>
  );
};

export default App;

This is panel header 1

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.

This is panel header 2

This is panel header 3

幽灵折叠面板

将折叠面板的背景变成透明。

TypeScript
JavaScript
import React from 'react';
import { Collapse } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => (
  <Collapse defaultActiveKey={['1']} ghost>
    <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>
);

export default App;

This panel can only be collapsed by clicking 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.

This panel can only be collapsed by clicking icon

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.

This panel can't be collapsed

可折叠触发区域

通过 collapsible 属性，可以设置面板的可折叠触发区域。

TypeScript
JavaScript
import React from 'react';
import { Collapse, Space } from 'antd';

const { Panel } = Collapse;

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 App: React.FC = () => (
  <Space direction="vertical">
    <Collapse collapsible="header" defaultActiveKey={['1']}>
      <Panel header="This panel can only be collapsed by clicking text" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
    <Collapse collapsible="icon" defaultActiveKey={['1']}>
      <Panel header="This panel can only be collapsed by clicking icon" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
    <Collapse collapsible="disabled">
      <Panel header="This panel can't be collapsed" key="1">
        <p>{text}</p>
      </Panel>
    </Collapse>
  </Space>
);

export default App;
#components-collapse-demo-collapsible .ant-space {
  width: 100%;
}

API

Collapse

参数	说明	类型	默认值	版本
accordion	手风琴模式	boolean	false
activeKey	当前激活 tab 面板的 key	string[] \| string number[] \| number	默认无，accordion 模式下默认第一个元素
bordered	带边框风格的折叠面板	boolean	true
collapsible	所有子面板是否可折叠或指定可折叠触发区域	`header` \| `icon` \| `disabled`	-	4.9.0
defaultActiveKey	初始化选中面板的 key	string[] \| string number[] \| number	-
destroyInactivePanel	销毁折叠隐藏的面板	boolean	false
expandIcon	自定义切换图标	(panelProps) => ReactNode	-
expandIconPosition	设置图标位置	`start` \| `end`	-	4.21.0
ghost	使折叠面板透明且无边框	boolean	false	4.4.0
size	设置折叠面板大小	`large` \| `middle` \| `small`	`middle`	5.2.0
onChange	切换面板的回调	function	-

Collapse.Panel

参数	说明	类型	默认值	版本
collapsible	是否可折叠或指定可折叠触发区域	`header` \| `icon` \| `disabled`	-	4.9.0 (icon: 4.24.0)
extra	自定义渲染每个面板右上角的内容	ReactNode	-
forceRender	被隐藏时是否渲染 DOM 结构	boolean	false
header	面板头内容	ReactNode	-
key	对应 activeKey	string \| number	-
showArrow	是否展示当前面板上的箭头（为 false 时，collapsible 不能置为 icon）	boolean	true

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.

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => { const onChange = (key: string | string[]) => { console.log(key); }; return ( <Collapse defaultActiveKey={['1']} onChange={onChange}> <Panel header="This is panel header 1" key="1"> {text} </Panel> <Panel header="This is panel header 2" key="2"> {text} </Panel> <Panel header="This is panel header 3" key="3"> {text} </Panel> </Collapse> ); }; export default App;

import React from 'react'; import { Collapse, Divider } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => ( <> <Divider orientation="left">Default Size</Divider> <Collapse> <Panel header="This is default size panel header" key="1"> {text} </Panel> </Collapse> <Divider orientation="left">Small Size</Divider> <Collapse size="small"> <Panel header="This is small size panel header" key="1"> {text} </Panel> </Collapse> <Divider orientation="left">Large Size</Divider> <Collapse size="large"> <Panel header="This is large size panel header" key="1"> {text} </Panel> </Collapse> </> ); export default App;

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => ( <Collapse accordion> <Panel header="This is panel header 1" key="1"> {text} </Panel> <Panel header="This is panel header 2" key="2"> {text} </Panel> <Panel header="This is panel header 3" key="3"> {text} </Panel> </Collapse> ); export default App;

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => { const onChange = (key: string | string[]) => { console.log(key); }; return ( <Collapse onChange={onChange}> <Panel header="This is panel header 1" key="1"> <Collapse defaultActiveKey="1"> <Panel header="This is panel nest panel" key="1"> {text} </Panel> </Collapse> </Panel> <Panel header="This is panel header 2" key="2"> {text} </Panel> <Panel header="This is panel header 3" key="3"> {text} </Panel> </Collapse> ); }; export default App;

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.

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => ( <Collapse bordered={false} defaultActiveKey={['1']}> <Panel header="This is panel header 1" key="1"> {text} </Panel> <Panel header="This is panel header 2" key="2"> {text} </Panel> <Panel header="This is panel header 3" key="3"> {text} </Panel> </Collapse> ); export default App;

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.

import React from 'react'; import { CaretRightOutlined } from '@ant-design/icons'; import { Collapse, theme } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => { const { token } = theme.useToken(); const panelStyle = { marginBottom: 24, background: token.colorFillAlter, borderRadius: token.borderRadiusLG, border: 'none', }; return ( <Collapse bordered={false} defaultActiveKey={['1']} expandIcon={({ isActive }) => <CaretRightOutlined rotate={isActive ? 90 : 0} />} style={{ background: token.colorBgContainer }} > <Panel header="This is panel header 1" key="1" style={panelStyle}> {text} </Panel> <Panel header="This is panel header 2" key="2" style={panelStyle}> {text} </Panel> <Panel header="This is panel header 3" key="3" style={panelStyle}> {text} </Panel> </Collapse> ); }; export default App;

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => { const onChange = (key: string | string[]) => { console.log(key); }; return ( <Collapse defaultActiveKey={['1']} onChange={onChange}> <Panel header="This is panel header with arrow icon" key="1"> {text} </Panel> <Panel showArrow={false} header="This is panel header with no arrow icon" key="2"> {text} </Panel> </Collapse> ); }; export default App;

import React, { useState } from 'react'; import { SettingOutlined } from '@ant-design/icons'; import { Collapse, Select } from 'antd'; const { Panel } = Collapse; const { Option } = Select; 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. `; type ExpandIconPosition = 'start' | 'end'; const App: React.FC = () => { const [expandIconPosition, setExpandIconPosition] = useState<ExpandIconPosition>('start'); const onPositionChange = (newExpandIconPosition: ExpandIconPosition) => { setExpandIconPosition(newExpandIconPosition); }; const onChange = (key: string | string[]) => { console.log(key); }; const genExtra = () => ( <SettingOutlined onClick={(event) => { // If you don't want click extra trigger collapse, you can prevent this: event.stopPropagation(); }} /> ); return ( <> <Collapse defaultActiveKey={['1']} onChange={onChange} expandIconPosition={expandIconPosition} > <Panel header="This is panel header 1" key="1" extra={genExtra()}> <div>{text}</div> </Panel> <Panel header="This is panel header 2" key="2" extra={genExtra()}> <div>{text}</div> </Panel> <Panel header="This is panel header 3" key="3" extra={genExtra()}> <div>{text}</div> </Panel> </Collapse> Expand Icon Position: <Select value={expandIconPosition} style={{ margin: '0 8px' }} onChange={onPositionChange}> <Option value="start">start</Option> <Option value="end">end</Option> </Select> </> ); }; export default App;

import React from 'react'; import { Collapse } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => ( <Collapse defaultActiveKey={['1']} ghost> <Panel header="This is panel header 1" key="1"> {text} </Panel> <Panel header="This is panel header 2" key="2"> {text} </Panel> <Panel header="This is panel header 3" key="3"> {text} </Panel> </Collapse> ); export default App;

import React from 'react'; import { Collapse, Space } from 'antd'; const { Panel } = Collapse; 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 App: React.FC = () => ( <Space direction="vertical"> <Collapse collapsible="header" defaultActiveKey={['1']}> <Panel header="This panel can only be collapsed by clicking text" key="1"> {text} </Panel> </Collapse> <Collapse collapsible="icon" defaultActiveKey={['1']}> <Panel header="This panel can only be collapsed by clicking icon" key="1"> {text} </Panel> </Collapse> <Collapse collapsible="disabled"> <Panel header="This panel can't be collapsed" key="1"> {text} </Panel> </Collapse> </Space> ); export default App;

API

Collapse

参数	说明	类型	默认值	版本
accordion	手风琴模式	boolean	false
activeKey	当前激活 tab 面板的 key	string[] \| string number[] \| number	默认无，accordion 模式下默认第一个元素
bordered	带边框风格的折叠面板	boolean	true
collapsible	所有子面板是否可折叠或指定可折叠触发区域	`header` \| `icon` \| `disabled`	-	4.9.0
defaultActiveKey	初始化选中面板的 key	string[] \| string number[] \| number	-
destroyInactivePanel	销毁折叠隐藏的面板	boolean	false
expandIcon	自定义切换图标	(panelProps) => ReactNode	-
expandIconPosition	设置图标位置	`start` \| `end`	-	4.21.0
ghost	使折叠面板透明且无边框	boolean	false	4.4.0
size	设置折叠面板大小	`large` \| `middle` \| `small`	`middle`	5.2.0
onChange	切换面板的回调	function	-

Collapse.Panel

参数	说明	类型	默认值	版本
collapsible	是否可折叠或指定可折叠触发区域	`header` \| `icon` \| `disabled`	-	4.9.0 (icon: 4.24.0)
extra	自定义渲染每个面板右上角的内容	ReactNode	-
forceRender	被隐藏时是否渲染 DOM 结构	boolean	false
header	面板头内容	ReactNode	-
key	对应 activeKey	string \| number	-
showArrow	是否展示当前面板上的箭头（为 false 时，collapsible 不能置为 icon）	boolean	true

Ant Design

Collapse折叠面板

Ant Design

Collapse折叠面板

何时使用

代码演示

API

Collapse

Collapse.Panel

何时使用

代码演示

API

Collapse

Collapse.Panel