CheckboxAttributes

Attribute names of <vaadin-checkbox>, for use with setAttribute.

Properties

Link copied to clipboard

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.

Link copied to clipboard

String used to label the component for screen reader users.

Link copied to clipboard

A space-separated list of IDs referencing the elements that label the component for screen reader users.

Link copied to clipboard
const val autofocus: String

Specify that this control should have input focus when the page loads.

Link copied to clipboard
const val checked: String

True if the element is checked.

Link copied to clipboard
const val disabled: String

If true, the user cannot interact with this element.

Link copied to clipboard
const val errorMessage: String

Error to show when the field is invalid.

Link copied to clipboard
const val helperText: String

String used for the helper text.

Link copied to clipboard

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.

Link copied to clipboard
const val invalid: String

Set to true when the field is invalid.

Link copied to clipboard
const val label: String

The label text for the input node. When no light dom defined via slot=label, this value will be used.

Link copied to clipboard

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.

Link copied to clipboard
const val name: String

The name of the control, which is submitted with the form data.

Link copied to clipboard
const val readonly: String

When true, the user cannot modify the value of the control. The difference between disabled and readonly is that the read-only element remains focusable, is announced by screen readers and its value can be submitted as part of the form.

Link copied to clipboard
const val required: String

Specifies that the user must fill in a value.

Link copied to clipboard
const val theme: String

The theme variants to apply to the component.

Link copied to clipboard
const val value: String

The value of the field.