Back to CheckboxGroup
View full API on CheckboxGroup
CheckboxGroup
Options API
Notification channels with four options and controlled value.
Product updates and account alerts.
Security codes and urgent messages.
Mobile alerts when you're away from email.
A summary every Monday morning.
Choose every channel you want to hear from us on.
API
| Prop | Type | Default | Description |
|---|---|---|---|
| options* | { value: string; text: string; disabled?: boolean; helpText?: React.ReactNode }[] | — | Multi-select option list. |
| value / defaultValue | string[] | — | Controlled / uncontrolled selected values. |
| onValueChange | (value: string[]) => void | — | Fires when the selection changes. |
| label | React.ReactNode | — | Top field label. |
| helpText | React.ReactNode | — | Group-level help text. |
| error | React.ReactNode | — | Error text; sets `aria-invalid` on the group. |
| orientation | "vertical" | "horizontal" | vertical | Stack options vertically or wrap horizontally. |
| controlPosition | "start" | "end" | start | Inline-start/end placement for each option. |