CustomFieldMixin

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 errorMessage: String

Error to show when the field is invalid.

Link copied to clipboard

A function to format the values of the individual fields contained by the custom field into a single component value. The function receives an array of all values of the individual fields in the order of their presence in the DOM, and must return a single component value. This function is called each time a value of an internal field is changed.

Link copied to clipboard
abstract var helperText: String

String used for the helper text.

Link copied to clipboard
abstract val inputs: Array<HTMLElement>?

Array of available input nodes

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 name: String

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

Link copied to clipboard

A function to parse the component value into values for the individual fields contained by the custom field. The function receives the component value, and must return an array of values for the individual fields in the order of their presence in the DOM. The function is called each time the value of the component changes.

Link copied to clipboard
abstract var required: Boolean

Specifies that the user must fill in a value.

Link copied to clipboard
abstract var value: String

The value of the field. When wrapping several inputs, it will contain \t (Tab character) as a delimiter indicating parts intended to be used as the corresponding inputs values. Use the #/elements/vaadin-custom-field#property-formatValue and #/elements/vaadin-custom-field#property-parseValue properties to customize this behavior.

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.