CheckboxGroupMixin

A mixin providing common checkbox-group functionality.

Inheritors

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
abstract var accessibleName: String

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
abstract var disabled: Boolean

If true, the user cannot interact with this element.

Link copied to clipboard
abstract var errorMessage: String

Error to show when the field is invalid.

Link copied to clipboard
abstract var helperText: String

String used for the helper text.

Link copied to clipboard
abstract var invalid: Boolean

Set to true when the field is invalid.

Link copied to clipboard
abstract var 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
abstract var readonly: Boolean

When true, the user cannot modify the value of the checkbox group. The difference between disabled and readonly is that in the read-only checkbox group, all the checkboxes are also read-only, and therefore remain focusable and announced by screen readers.

Link copied to clipboard
abstract var required: Boolean

Specifies that the user must fill in a value.

Link copied to clipboard
abstract var value: Array<JsAny?>

An array containing values of the currently checked checkboxes.

Functions

Link copied to clipboard
abstract fun checkValidity(): Boolean

Returns true if the field value satisfies all constraints (if any).

Link copied to clipboard
abstract fun validate(): Boolean

Validates the field and sets the invalid property based on the result.