Field

interface Field<V>

A field is a single input in a form. It has a name, a value, and a set of errors.

The type of the value of the field.

Properties

The errors of the field. If the field has no errors, this should be an empty list.

Returns true if the field has errors, false otherwise.

abstract val isDirty: Boolean

Returns true if the field is dirty, false otherwise. A field is dirty if its value has changed since the initial value.

Returns true if the field is enabled, false otherwise. A field is enabled if it is not disabled.

Returns true if the field is focused, false otherwise. Sets to focused when the field gains focus.

Returns true if the field is touched, false otherwise. Sets to touched when the field loses focus after being focused.

abstract val name: FieldName

The name of the field.

abstract val onBlur: () -> Unit

Callback to notify when the field loses focus.

abstract val onChange: (V) -> Unit

Callback to notify when the value of the field is changed.

abstract val onFocus: () -> Unit

Callback to notify when the field gains focus.

abstract val value: V

The value of the field.

Triggers validation of the field.