Checkbox
Checkbox with label, description, error state, and indeterminate support.
Example
We send updates monthly
Props
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
label | string | — | Required | Accessible label text |
description | string | — | No | Helper text |
error | string | — | No | Error message |
required | boolean | — | No | Marks as required |
hideLabel | boolean | false | No | Visually hides label |
indeterminate | boolean | false | No | Shows indeterminate state |
Accessibility
- Uses native <input type="checkbox"> for full screen reader support
- aria-checked="mixed" for indeterminate state
- aria-invalid when error is present
Related Tokens
--checkbox-surface--checkbox-on-surface--checkbox-border--checkbox-checked--checkbox-gap--checkbox-label-font-weight