Back to Checkbox
View full API on Checkbox
Checkbox
Labeled fields
Standalone checkbox with top label, inline text, and disabled states.
You agree to our Terms of Service and Privacy Policy.
Can't toggle this option.
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. |