CheckboxElement
<vaadin-checkbox> is an input field representing a binary choice.
<vaadin-checkbox label="I accept the terms and conditions"></vaadin-checkbox>Styling
The following shadow DOM parts are available for styling:
| Part name | Description |
|---|---|
checkbox | The element representing a stylable custom checkbox |
label | The slotted label element wrapper |
helper-text | The slotted helper text element wrapper |
error-message | The slotted error message element wrapper |
required-indicator | The required state indicator element |
The following state attributes are available for styling:
| Attribute | Description |
|---|---|
active | Set when the checkbox is activated with mouse, touch or the keyboard. |
checked | Set when the checkbox is checked. |
disabled | Set when the checkbox is disabled. |
readonly | Set when the checkbox is readonly. |
focus-ring | Set when the checkbox is focused using the keyboard. |
focused | Set when the checkbox is focused. |
indeterminate | Set when the checkbox is in the indeterminate state. |
invalid | Set when the checkbox is invalid. |
has-label | Set when the checkbox has a label. |
has-helper | Set when the checkbox has helper text. |
has-error-message | Set when the checkbox has an error message. |
has-tooltip | Set when the checkbox has a slotted tooltip. |
The following custom CSS properties are available for styling:
| Custom CSS property |
|---|
--vaadin-checkbox-background |
--vaadin-checkbox-border-color |
--vaadin-checkbox-border-radius |
--vaadin-checkbox-border-width |
--vaadin-checkbox-gap |
--vaadin-checkbox-label-color |
--vaadin-checkbox-label-font-size |
--vaadin-checkbox-label-font-weight |
--vaadin-checkbox-label-line-height |
--vaadin-checkbox-marker-color |
--vaadin-checkbox-marker-size |
--vaadin-checkbox-size |
--vaadin-input-field-error-color |
--vaadin-input-field-error-font-size |
--vaadin-input-field-error-font-weight |
--vaadin-input-field-error-line-height |
--vaadin-input-field-helper-color |
--vaadin-input-field-helper-font-size |
--vaadin-input-field-helper-font-weight |
--vaadin-input-field-helper-line-height |
--vaadin-input-field-required-indicator |
--vaadin-input-field-required-indicator-color |
See Styling Components documentation.
Properties
A space-separated list of IDs referencing the elements that describe the component for screen reader users. The referenced elements are announced in addition to the helper text and the error message.
String used to label the component for screen reader users.
A space-separated list of IDs referencing the elements that label the component for screen reader users.
Error to show when the field is invalid.
String used for the helper text.
True if the checkbox is in the indeterminate state which means it is not possible to say whether it is checked or unchecked. The state is reset once the user switches the checkbox by hand.
Set to true to enable manual validation mode. This mode disables automatic constraint validation, allowing you to control the validation process yourself. You can still trigger constraint validation manually with the validate() method or use checkValidity() to assess the component's validity without affecting the invalid state. In manual validation mode, you can also manipulate the invalid property directly through your application logic without conflicts with the component's internal validation.
Functions
Returns true if the field value satisfies all constraints (if any).