Checkbox

Checkboxes let people select one or more items from a list, or turn an item on or off.

Props

React props
Name	Type	Required	Default	Description
`className`	`string \| Partial<Record<"box" \| "input" \| "icon" \| "stateLayer" \| "checkbox", string>> \| ClassNameComponent<CheckboxInterface>`	No	`—`	Root classes (string), static element classes (object), or state-aware element classes (function).
`checked`	`boolean`	No	`—`	Controlled mode: explicitly control whether the checkbox is checked.
`disabled`	`boolean`	No	`false`	Prevents interaction and form changes.
`name`	`string`	No	`—`	Name of the underlying form control.
`required`	`boolean`	No	`false`	Requires the checkbox to be selected before its form can submit.
`value`	`string`	No	`—`	Value submitted with the form when checked.
`defaultChecked`	`boolean`	No	`false`	Uncontrolled mode: initial checked state.
`id`	`string`	No	`—`	Id of the underlying form control. Auto-generated if not provided.
`style`	`CSSProperties`	No	`—`	Styles applied to the Checkbox touch target.
`indeterminate`	`boolean`	No	`false`	Marks the checkbox as partially selected without changing its checked value.
`invalid`	`boolean`	No	`false`	Exposes the native invalid state and uses the error color role.
`onCheckedChange`	`(checked: boolean) => void`	No	`—`	Called once for each accepted checked-state transition.