valix-runtime/io.valix.runtime/FormState

FormState

class FormState<T>(initialValue: T, val validator: <Error class: unknown class><T>, val validationMode: ValidationMode = ValidationMode.OnChange, val failFast: Boolean = false)

Manages mutable form state and validation status for a target value object T.

Provides fields tracking (dirtyFields, touchedFields), validation triggers (onFieldChange, onFieldBlur), and async form submission helpers.

Parameters

T

The type of value or data class held by the form state.

initialValue

The starting value of the form.

validator

The ValixValidator compiled instance used to validate form data.

validationMode

Strategy determining when validation is triggered (ValidationMode.OnChange, ValidationMode.OnBlur, etc.).

failFast

If true, validation terminates immediately upon encountering the first error.

Constructors

constructor(initialValue: T, validator: <Error class: unknown class><T>, validationMode: ValidationMode = ValidationMode.OnChange, failFast: Boolean = false)

Properties

val dirtyFields: <Error class: unknown class>

Set of field names that have been modified.

val errors: List<<Error class: unknown class>>

Returns list of current validation errors.

val failFast: Boolean = false

val fieldErrors: Map<String, <Error class: unknown class>>

Returns current errors indexed by property field name.

var isDirty: Boolean

true if any field value has been modified since initialization or reset.

var isSubmitted: Boolean

true if the form submission has been triggered.

var isSubmitting: Boolean

true while the form submission callback is currently executing.

var isTouched: Boolean

true if any field has lost focus.

val isValid: Boolean

Returns true if current validation result is valid.

val touchedFields: <Error class: unknown class>

Set of field names that have lost focus.

val validationMode: ValidationMode

validationResult

var validationResult: <Error class: unknown class>

The current ValidationResult.

val validator: <Error class: unknown class><T>

var value: T

The current value instance.

Functions

fun clearErrors()

Clears all validation errors while keeping values intact.

fun errorFor(field: String): <Error class: unknown class>?

Returns the first ValidationError for the specified field, or null.

fun onFieldBlur(field: String)

Triggers field blur tracking and executes validation if mode is ValidationMode.OnBlur.

fun onFieldChange(field: String, newValue: T)

Triggers field update and executes validation if mode is ValidationMode.OnChange.

fun reset(initialValue: T)

Resets the form state to initialValue and clears all error/dirty state.

suspend fun submit(vararg groups: KClass<*>, onExecute: suspend (T) -> Unit)

Validates and executes onExecute if validation passes.

fun validate(vararg groups: KClass<*>): <Error class: unknown class>

Manually triggers validation for the specified groups.