Switch is used to toggle between two states on and off. It is commonly used in settings panel, forms and any other place where a user needs to enable or disable feature.
import Switch from "@radui/ui/Switch"Root component for the Switch component.
| Prop | Type | Default |
|---|---|---|
children | React.ReactNode | null |
customRootClass | string | '' |
color | string | '' |
variant | string | — |
size | string | — |
defaultChecked | boolean | false |
checked | boolean | — |
onCheckedChange | function | — |
disabled | boolean | false |
required | boolean | false |
name | string | — |
value | string | — |
asChild | boolean | false |
readOnly | boolean | false |
uncheckedValue | string | — |
form | string | — |
inputRef | Ref<HTMLInputElement> | — |
Thumb component for the Switch component.
| Prop | Type | Default |
|---|---|---|
asChild | boolean | false |
className | string | — |
children | ReactNode | — |
| Shortcut | Description |
|---|---|
| Tab | Moves focus to the switch. |
| Space | Toggles the checked state. |
| Enter | Toggles the checked state. |
| Reference | What Rad UI follows |
|---|---|
| Switch pattern | Uses switch semantics with aria-checked to expose the current on or off state. |