# Segmented

- Page: https://jiguang132.com/resources/ant-design-mobile/docs/segmented
- Resource: Ant Design Mobile (https://jiguang132.com/resources/ant-design-mobile.md)
- All guides: https://jiguang132.com/resources/ant-design-mobile/docs.md

This component is available since `antd-mobile@5.38.0`.

## Install

```bash
npm install antd-mobile@5.43.0
```

antd-mobile is for mobile web, not React Native or Mini Programs. React 19 projects must register `createRoot` with `unstableSetRender` at the entry, or imperative APIs such as Toast and Dialog cannot render. Switch dark mode with `<html data-prefers-color-scheme="dark">`.

Examples come from the official Ant Design Mobile repository (MIT) at the commit published as npm 5.43.0. Presentation helpers such as `DemoBlock` are JGuang rewrites, not antd-mobile APIs.

This component is available since `antd-mobile@5.38.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.

## Demos

## Segmented

### Props

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| 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\[] \| SegmentedItemType\[] | [] |
| value | Currently selected value | string \| number |  |

### SegmentedItemType

| Property  | Description                      | Type             | Default |
| --------- | -------------------------------- | ---------------- | ------- |
| label     | Display text for Segmented item  | ReactNode        | -       |
| value     | Value for Segmented item         | string \| number | -       |
| icon      | Display icon for Segmented item  | ReactNode        | -       |
| disabled  | Disabled state of segmented item | boolean          | false   |
| className | The additional css class         | string           | -       |

### CSS Variables

| Name | Description | Default |
| --- | --- | --- |
| Name | Description | Default |
| ------------------- | ---------------------- | ----------------------- |
| --segmented-background | Background color | `var(--adm-color-fill-content)` |
| --segmented-item-color | Text color of segment item | `var(--adm-color-text-secondary)` |
| --segmented-item-selected-background | Background color of selected segment | `var(--adm-color-background)` |
| --segmented-item-selected-color | Text color of selected segment item | `var(--adm-color-text)` |
| --segmented-item-disabled-color | Text color of disabled segment item | `var(--adm-color-weak)` |

---

Index of all JGuang resources: https://jiguang132.com/llms.txt