soil-form/soil.form.compose/FormMetaState

FormMetaState

@Stable
class FormMetaState : FormMeta(source)

A mutable implementation of FormMeta that tracks form-level metadata.

This class manages form-wide metadata including field states and submission readiness. It provides mutable access to form metadata for internal form management operations.

Constructors

Link copied to clipboard
constructor(policy: FormPolicy = FormPolicy())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override var canSubmit: Boolean

Whether the form is ready for submission. This is typically true when all required fields are valid and any pre-validation has passed.

Link copied to clipboard
open override val fields: MutableMap<FieldName, FieldMetaState>

A map of field names to their corresponding metadata. Contains information about each field's validation state, errors, and user interactions.

Link copied to clipboard

Functions

Link copied to clipboard
fun reset(block: () -> Unit)

Resets the form metadata and executes a custom reset block for synchronization.

Link copied to clipboard
fun setError(vararg pairs: Pair<FieldName, FieldError>)

Sets validation errors for specific fields.

Link copied to clipboard
open override fun toString(): String