mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-15 17:19:11 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
---
|
|
category: Components
|
|
group: Data Display
|
|
title: Segmented
|
|
cover: https://gw.alipayobjects.com/zos/bmw-prod/a3ff040f-24ba-43e0-92e9-c845df1612ad.svg
|
|
demo:
|
|
cols: 2
|
|
---
|
|
|
|
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.
|
|
|
|
## Examples
|
|
|
|
<!-- prettier-ignore -->
|
|
<code src="./demo/basic.tsx">Basic</code>
|
|
<code src="./demo/block.tsx">Block Segmented</code>
|
|
<code src="./demo/disabled.tsx">Basic</code>
|
|
<code src="./demo/controlled.tsx">Controlled mode</code>
|
|
<code src="./demo/custom.tsx">Custom Render</code>
|
|
<code src="./demo/dynamic.tsx">Dynamic</code>
|
|
<code src="./demo/size.tsx">Three sizes of Segmented</code>
|
|
<code src="./demo/with-icon.tsx">With Icon</code>
|
|
<code src="./demo/icon-only.tsx">With Icon only</code>
|
|
<code src="./demo/controlled-two.tsx" debug>Controlled Synced mode</code>
|
|
<code src="./demo/size-consistent.tsx" debug>Consistent height</code>
|
|
|
|
## 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 | | |
|