This is a Technical Preview for
Checkbox will be generally available in the next
Please use FormControl to display accessible checkboxes in the UI. This
Checkbox component is intended only as an ingredient for other custom components, or as a drop-in replacement for native HTML checkboxes outside of form use-cases.
If you intend to use this component as part of another component, it should always be accompanied by a corresponding
<label> to improve support for assistive technologies.
Checkbox component can be used in controlled and uncontrolled modes.
indeterminate checkbox state should be used if the input value is neither
false. This can be useful in situations where you are required to display an incomplete state, or one that is dependent on other input selections to determine a value.
Apply an optional border using
Checkbox provides a React alternative to the native HTML
The component API supports all standard HTML attribute props, while providing some additional behavior as described below.
|Modifies true/false value of the native checkbox|
|Sets a custom class|
|Checks the input by default in uncontrolled mode|
|Modifies the native disabled state of the native checkbox|
|Sets a custom id|
|Applies an indeterminate state to the checkbox|
|Forward a Ref to the underlying DOM node|
|Ussed to inform ARIA attributes. Individual checkboxes do not have validation styles.|
Additional props can be passed to the
<input> element. See MDN for a list of props accepted by the