Checkbox

Use Checkbox for independent yes or no choices and consent actions.

Example

API reference

CheckboxProps

labelstring

Name: label

Description: Text label associated with checkbox input.

Type: string

Default:

indeterminatebooleanfalse

Name: indeterminate

Description: Sets mixed state on native checkbox element.

Type: boolean

Default: false

errorstring

Name: error

Description: Error message rendered with alert role.

Type: string

Default:

helperTextstring

Name: helperText

Description: Optional helper copy below the checkbox.

Type: string

Default:

Accessibility

  • WCAG 1.3.1: Label and checkbox are correctly associated.
  • WCAG 2.1.1: Space key toggles state through keyboard interaction.
  • WCAG 4.1.2: Checked and unchecked states are announced.

Playground

Open Checkbox stories