The checkbox component allows the user to select one or more items from a set. Checkboxes can also be used to turn an option on or off.
Variants
Variants contain different versions of the component depending on specific properties, such as state, size, colour, optional iconography, etc.
| Property | Values | Default |
|---|---|---|
| State Variant | default | checked | intermident | default |
| Nested Variant | False | True | False |
| Show Info Icon Boolean | true | false | false |
| Show Notes Boolean | true | false | false |
| Disabled Variant | False | True | False |
Note
Notes can be shown underneath the checkbox label to provide additional context.
Errors and warnings
When there is an error or warning that needs to be shown against the checkbox, the error and warning props can be used.
This will be displayed below the checkbox. Only one of error or warning can be displayed at a time, if both are specified then only the error will be displayed.
Help and support