ant-design/components/segmented/index.en-US.md
XIN HU 4fd49a8f7f
docs: Segmented API type (#35974)
* Update index.en-US.md

* Update index.zh-CN.md
2022-06-09 21:39:35 +08:00

1.1 KiB

category type title cover
Components Data Display Segmented https://gw.alipayobjects.com/zos/bmw-prod/a3ff040f-24ba-43e0-92e9-c845df1612ad.svg

Segmented Controls. This component is available since antd@4.20.0.

When To Use

  • When displaying multiple options and user can select a single option;
  • When switching the selected option, the content of the associated area changes.

API

This component is available since antd@4.20.0

Property Description Type Default Version
block Option to fit width to its parent's width boolean false
defaultValue Default selected value string | number
disabled Disable all segments boolean false
onChange The callback function that is triggered when the state changes function(value: string | number)
options Set children optional string[] | number[] | Array<{ label: ReactNode value: string icon? ReactNode disabled?: boolean className?: string }> []
size The size of the Segmented. large | middle | small -
value Currently selected value string | number