soil-form/soil.form.compose/FormBinding

FormBinding

Internal interface for form binding operations.

This interface provides the low-level binding operations between form fields and the form state. It handles field registration, validation, and state management. This is an internal API and should not be used directly by application code.

Parameters

The type of the form data.

Properties

fieldChanges

abstract val fieldChanges: SharedFlow<FieldName>

A shared flow of field change notifications.

policy

abstract val policy: FormPolicy

The form policy that defines validation behavior.

state

abstract val state: FormData<T>

The current state of the form including data and metadata.

Functions

get

abstract operator fun get(name: FieldName): FieldMetaState?

Gets the metadata for a specific field.

handleChange

abstract fun handleChange(updater: T.() -> T)

Handles a change to the form data.

notifyFieldChange

abstract suspend fun notifyFieldChange(name: FieldName)

Notifies the form that a field's validation target has changed.

abstract fun register(name: FieldName, rule: FieldRule<T>)

Registers a field with its validation rule.

set

abstract operator fun set(name: FieldName, fieldMeta: FieldMetaState)

Sets the metadata for a specific field.

unregister

abstract fun unregister(name: FieldName)

Unregisters a field from the form.

validate

abstract fun validate(value: T, dryRun: Boolean): Boolean

Validates the form data.