Checkbox allows users to select one or more options, including checked, unchecked, and indeterminate states.
Click or press Space to toggle. Screen readers announce checked/unchecked state via aria-checked.
<Checkbox id='basic-checkbox'>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='basic-checkbox'>Accept terms</Label>Parent manages the checked state. External buttons can also change the state.
const [checked, setChecked] = useState<CheckedState>(false);
<Checkbox id='controlled-checkbox' checked={checked} onChange={(c)=>setChecked(c)}>
{({ checked }) => (checked === true ? '✓' : '')}
</Checkbox>
<Label htmlFor='controlled-checkbox'>Controlled checkbox</Label>Checkbox can be in a "mixed" state using aria-checked="mixed". Screen readers should announce "partially checked" or "mixed".
const [checked, setChecked] = useState<CheckedState>('indeterminate');
<Checkbox id='indeterminate-checkbox' checked={checked} onChange={(c)=>setChecked(c)}>
{({ checked }) => (checked === 'indeterminate' ? '–' : checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='indeterminate-checkbox'>Select all items</Label>Disabled checkboxes cannot be interacted with and are announced as disabled.
<Checkbox id='disabled-unchecked' disabled>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='disabled-unchecked' disabled>
Disabled (unchecked)
</Label>
<Checkbox id='disabled-checked' disabled defaultChecked>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='disabled-checked' disabled>
Disabled (checked)
</Label>Read-only checkboxes are focusable but cannot be changed. Announced with aria-readonly.
<Checkbox id='readonly-checkbox' readOnly defaultChecked>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='readonly-checkbox' readOnly>
Read-only (checked)
</Label>Required checkboxes are announced with aria-required.
<Checkbox id='required-checkbox' required>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='required-checkbox' required>
I agree to the terms *
</Label>A parent checkbox controls child checkboxes. The parent shows indeterminate when some (but not all) children are checked.
const [values, setValues] = useState({ terms: false, newsletter: false, privacy: false });
<Checkbox
id='select-all'
checked={values.terms && values.newsletter && values.privacy ? true : values.terms || values.newsletter || values.privacy ? 'indeterminate' : false}
onChange={(checked) => {
const next = checked === true;
setValues({ terms: next, newsletter: next, privacy: next });
}}
>
{({ checked }) => (checked === 'indeterminate' ? '–' : checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='select-all'>Select all</Label>
<Checkbox
id='group-terms'
checked={values.terms}
onChange={(checked) => setValues((prev) => ({ ...prev, terms: checked }))}
>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='group-terms'>Terms</Label>
<Checkbox
id='group-newsletter'
checked={values.newsletter}
onChange={(checked) => setValues((prev) => ({ ...prev, newsletter: checked }))}
>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='group-newsletter'>Newsletter</Label>
<Checkbox
id='group-privacy'
checked={values.privacy}
onChange={(checked) => setValues((prev) => ({ ...prev, privacy: checked }))}
>
{({ checked }) => (checked ? '✓' : '')}
</Checkbox>
<Label htmlFor='group-privacy'>Privacy</Label>