Back to Switch
View full API on Switch
Switch
Labeled fields
Standalone switch with top label and disabled states.
Receive product updates and release notes.
This setting is locked.
API
| Prop | Type | Default | Description |
|---|---|---|---|
| checked / defaultChecked | boolean | — | Controlled / uncontrolled on state. |
| onCheckedChange | (checked: boolean) => void | — | Fires when the value changes. |
| label | React.ReactNode | — | Top field label. |
| text | React.ReactNode | — | Inline label text beside the switch. |
| helpText | React.ReactNode | — | Supplementary help text. |
| controlPosition | "start" | "end" | end | Inline-start/end placement (RTL-aware). |
| disabled | boolean | — | Native disabled state. |