Checkbox
Also known as: Tickbox, Selection box
Resources
Properties
| Property | Values | Default |
|---|---|---|
Selected Variant | Unchecked | Indeterminate | Checked | Unchecked |
State Variant | Default | Hover | Focus | Error | Disabled | Default |
Has label Boolean | true | false | true |
Label Text | string | Label |
Label position Variant | Start | End | End |
When to use
If users need to select one or more options from a list.
When enabling or disabling settings (agreeing to marketing messages or terms & conditions).
If clear visibility of all choices is important.
If only one option should be selected, use radio instead.
When action requires an immediate effect, use switch instead.
If the selection of options is too long, use select instead.
Behaviour
Selection
Checkbox has three selection states:
- Usually,
uncheckedstate is the default. checkedstate can also be used as the default in specific contexts where opting in is expected or beneficial.indeterminatestate represents a partially selected state. Can be used as a parent checkbox, when some, but not all, child checkboxes are selected.
States
Checkbox (and all other forms and selection controls) express states. States indicate current condition of the component to someone interacting with it. Using states ensure clear user feedback, highlighting possible actions or barriers. We have included most common states:
| State | Context |
|---|---|
Default | Status of the component before the interaction. Also referred to as ‘resting’. |
Hover | When the user moves their cursor over the component, but is not taking the action. Slight visual change can indicate interactivity of the component. |
Focus | When user selects the component via keyboard navigation, but has not yet taken action on it. |
Error | Used when an invalid action occurs. Component may appear red or display helper, signaling an issue that needs resolution. |
Disabled | A non-interactive state where the component appears faded or grayed out. It indicates that the action is unavailable at the moment. |