Back to SwitchGroup
View full API on SwitchGroup
SwitchGroup
Options API
Privacy settings with four independent toggles.
Let teammates find you by name.
Display when you were last active.
Help improve the product with anonymous data.
Occasional emails from trusted partners.
Toggle each setting on or off independently.
API
| Prop | Type | Default | Description |
|---|---|---|---|
| options* | { value: string; text: string; disabled?: boolean; helpText?: React.ReactNode }[] | — | Multi-toggle option list. |
| value / defaultValue | string[] | — | Controlled / uncontrolled enabled values. |
| onValueChange | (value: string[]) => void | — | Fires when the enabled set changes. |
| label | React.ReactNode | — | Top field label. |
| helpText | React.ReactNode | — | Group-level help text. |
| orientation | "vertical" | "horizontal" | vertical | Stack options vertically or wrap horizontally. |
| controlPosition | "start" | "end" | end | Inline-start/end placement for each option. |