Segmented分段控制器

分段控制器。自 [email protected] 版本开始提供该组件。

何时使用#

用于展示多个选项并允许用户选择其中单个选项；
当切换选中选项时，关联区域的内容会发生变化。

代码演示

最简单的用法。

import { Segmented } from 'antd';

ReactDOM.render(
  <Segmented options={['Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly']} />,
  mountNode,
);
.code-box-demo {
  overflow-x: auto;
}

.code-box-demo .ant-segmented {
  margin-bottom: 10px;
}

不可用

Segmented 不可用。

import { Segmented } from 'antd';

ReactDOM.render(
  <>
    <Segmented options={['Map', 'Transit', 'Satellite']} disabled />
    <br />
    <Segmented
      options={[
        'Daily',
        { label: 'Weekly', value: 'Weekly', disabled: true },
        'Monthly',
        { label: 'Quarterly', value: 'Quarterly', disabled: true },
        'Yearly',
      ]}
    />
  </>,
  mountNode,
);

List

Kanban

设置图标

给 Segmented Item 设置 Icon。

import { Segmented } from 'antd';
import { AppstoreOutlined, BarsOutlined } from '@ant-design/icons';

ReactDOM.render(
  <Segmented
    options={[
      {
        label: 'List',
        value: 'List',
        icon: <BarsOutlined />,
      },
      {
        label: 'Kanban',
        value: 'Kanban',
        icon: <AppstoreOutlined />,
      },
    ]}
  />,
  mountNode,
);

三种大小

我们为 <Segmented /> 组件定义了三种尺寸（大、默认、小），高度分别为 40px、32px 和 24px。

import { Segmented } from 'antd';

ReactDOM.render(
  <>
    <Segmented size="large" options={['Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly']} />
    <br />
    <Segmented options={['Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly']} />
    <br />
    <Segmented size="small" options={['Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly']} />
  </>,
  mountNode,
);

123

456

longtext-longtext-longtext-longtext

Block 分段选择器

block 属性使其适合父元素宽度。

import { Segmented } from 'antd';

ReactDOM.render(
  <Segmented block options={[123, 456, 'longtext-longtext-longtext-longtext']} />,
  mountNode,
);

Map

Transit

Satellite

受控模式

受控的 Segmented。

import React, { useState } from 'react';
import { Segmented } from 'antd';

const Demo: React.FC = () => {
  const [value, setValue] = useState('Map');

  return (
    <Segmented
      options={['Map', 'Transit', 'Satellite']}
      value={value}
      onChange={e => setValue(e.target.value)}
    />
  );
};

ReactDOM.render(<Demo />, mountNode);

Daily

Weekly

Monthly

动态数据

动态加载数据。

TypeScript
JavaScript
import React, { useState } from 'react';
import { Segmented, Button } from 'antd';

const defaultOptions = ['Daily', 'Weekly', 'Monthly'];

const Demo: React.FC = () => {
  const [options, setOptions] = useState(defaultOptions);
  const [moreLoaded, setMoreLoaded] = useState(false);

  const handleLoadOptions = () => {
    setOptions([...defaultOptions, 'Quarterly', 'Yearly']);
    setMoreLoaded(true);
  };

  return (
    <>
      <Segmented options={options} />
      <br />
      <Button type="primary" disabled={moreLoaded} onClick={handleLoadOptions}>
        Load more options
      </Button>
    </>
  );
};

export default Demo;

自定义渲染

使用 ReactNode 自定义渲染每一个 Segmented Item。

import { Avatar, Segmented } from 'antd';
import { UserOutlined } from '@ant-design/icons';

ReactDOM.render(
  <>
    <Segmented
      options={[
        {
          label: (
            <>
              <Avatar src="https://joeschmoe.io/api/v1/random" />
              <div>User 1</div>
            </>
          ),
          value: 'user1',
        },
        {
          label: (
            <>
              <Avatar style={{ backgroundColor: '#f56a00' }}>K</Avatar>
              <div>User 2</div>
            </>
          ),
          value: 'user2',
        },
        {
          label: (
            <>
              <Avatar style={{ backgroundColor: '#87d068' }} icon={<UserOutlined />} />
              <div>User 3</div>
            </>
          ),
          value: 'user3',
        },
      ]}
    />
    <br />
    <Segmented
      options={[
        {
          label: (
            <>
              <div>Spring</div>
              <div>Jan-Mar</div>
            </>
          ),
          value: 'spring',
        },
        {
          label: (
            <>
              <div>Summer</div>
              <div>Apr-Jun</div>
            </>
          ),
          value: 'summer',
        },
        {
          label: (
            <>
              <div>Autumn</div>
              <div>Jul-Sept</div>
            </>
          ),
          value: 'autumn',
        },
        {
          label: (
            <>
              <div>Winter</div>
              <div>Oct-Dec</div>
            </>
          ),
          value: 'winter',
        },
      ]}
    />
  </>,
  mountNode,
);

只设置图标

在 Segmented Item 选项中只设置 Icon。

import { Segmented } from 'antd';
import { AppstoreOutlined, BarsOutlined } from '@ant-design/icons';

export default () => (
  <Segmented
    options={[
      {
        value: 'List',
        icon: <BarsOutlined />,
      },
      {
        value: 'Kanban',
        icon: <AppstoreOutlined />,
      },
    ]}
  />
);

参数	说明	类型	默认值
block	将宽度调整为父元素宽度的选项	boolean	false
defaultValue	默认选中的值	string \| number
disabled	是否禁用	boolean	false
onChange	选项变化时的回调函数	function(e:Event)
options	数据化配置选项内容	string[] \| number[] \| Array<{ label: string value: string icon? ReactNode disabled?: boolean className?: string }>	[]
size	控件尺寸	`large` \| `middle` \| `small`	-
value	当前选中的值	string \| number

Ant Design

Segmented分段控制器

何时使用#

代码演示

API#

Segmented#