ant-design/components/segmented/index.zh-CN.md
vagusX 9484dd3d1e
docs: improve Segmented docs with SegmentedItemType (#50205)
* docs: improve Segmented docs with SegmentedItemType

* chore: update

* chore: update

* test: update snapshot

* docs: update
2024-08-03 11:49:19 +08:00

2.6 KiB
Raw Blame History

category group title subtitle description cover coverDark demo
Components 数据展示 Segmented 分段控制器 用于展示多个选项并允许用户选择其中单个选项。 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*XJR2TbS1aaQAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-9tSSoO_MkIAAAAAAAAAAAAADrJ8AQ/original
cols
2

antd@4.20.0 版本开始提供该组件。

何时使用

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

代码演示

基本 Block 分段选择器 不可用 受控模式 自定义渲染 动态数据 三种大小 设置图标 只设置图标 受控同步模式 统一高度 自定义组件 Token

API

通用属性参考:通用属性

antd@4.20.0 版本开始提供该组件。

Segmented

参数 说明 类型 默认值 版本
block 将宽度调整为父元素宽度的选项 boolean false
defaultValue 默认选中的值 string | number
disabled 是否禁用 boolean false
onChange 选项变化时的回调函数 function(value: string | number)
options 数据化配置选项内容 string[] | number[] | SegmentedItemType[] []
size 控件尺寸 large | middle | small middle
value 当前选中的值 string | number

SegmentedItemType

属性 描述 类型 默认值 版本
label 分段项的显示文本 ReactNode -
value 分段项的值 string | number -
icon 分段项的显示图标 ReactNode -
disabled 分段项的禁用状态 boolean false
className 自定义类名 string -

主题变量Design Token