Back to Checkbox
View full API on Checkbox
Checkbox
Control position
Inline-start vs inline-end checkbox placement.
Checkbox appears before the label text in LTR.
Checkbox appears after the label text in LTR.
API
| Prop | Type | Default | Description |
|---|---|---|---|
| checked / defaultChecked | boolean | "indeterminate" | — | Controlled / uncontrolled checked state. |
| onCheckedChange | (checked: boolean | "indeterminate") => void | — | Fires when the value changes. |
| label | React.ReactNode | — | Top field label — matches Input and Textarea. |
| text | React.ReactNode | — | Inline label text beside the checkbox. |
| helpText | React.ReactNode | — | Supplementary help text linked via `aria-describedby`. |
| controlPosition | "start" | "end" | start | Places the control at inline-start or inline-end (RTL-aware). |
| disabled | boolean | — | Native disabled state. |
| required | boolean | — | Marks the checkbox as required in forms. |