Vivid Logo Vivid

Checkbox

Checkboxes allow users to select one or more items from a list of options.

Labelling

Label Text

Use the label attribute to provide a visible label for the Checkbox.

Helper Text

Use the helper-text attribute or slot to provide additional context or instructions for the Checkbox.

States

Checked

The checked property or current-checked attribute controls the checked state of the Checkbox.

Indeterminate

Checkboxes support an indeterminate state, which indicates that the Checkbox is neither checked nor unchecked.

The indeterminate state is mainly used to implement Select all / none functionality.

Use the indeterminate property to set the Checkbox to indeterminate.

Disabled

Toggle the disabled member to disable/enable the Checkbox.

Read Only

Set the readonly member to specify a Checkbox is read-only. A read-only Checkbox cannot be modified (however it can be focused and tabbed into).

Validation Feedback

Error Text

The error-text attribute provides a custom error message. Any current error state will be overridden by error-text.

Success Text

The success-text attribute provides a custom success message. Any current error state will be overridden by success-text.

Connotation

Use the connotation attribute to set the Checkbox color.