1.0.0-alpha15

soil-form/soil.form

Package-level declarations

Types

value class FieldError(val messages: List<String>)

Represents validation errors for a form field.

interface FieldMeta

Represents metadata for an individual form field.

typealias FieldName = String

A type alias for field names used to uniquely identify fields within a form.

typealias FieldNames = Set<FieldName>

A type alias for a set of field names.

interface FieldOptions

Configuration options for field-level validation behavior.

FieldPassthroughAdapter

class FieldPassthroughAdapter<V> : FieldTypeAdapter<V, V, V>

A passthrough adapter that performs no type conversion.

FieldTypeAdapter

interface FieldTypeAdapter<V, S, U>

An adapter interface for converting between different type representations of a field value.

FieldValidationMode

enum FieldValidationMode : Enum<FieldValidationMode>

Defines when field validation should be triggered.

FieldValidationStrategy

interface FieldValidationStrategy

Defines a strategy for determining when field validation should occur.

typealias FieldValidator<V> = (V) -> FieldError

A type alias for field validation functions.

interface FormData<T>

Represents the complete state of a form including its data and metadata.

interface FormMeta

Represents metadata for a form, including field-level information and submission state.

interface FormOptions

Configuration options for form-level validation behavior.

Properties

val noFieldError: FieldError

A constant representing no validation errors.

Functions

fun FieldOptions(validationStrategy: FieldValidationStrategy = FieldOptions.validationStrategy, validationDelayOnMount: Duration = FieldOptions.validationDelayOnMount, validationDelayOnChange: Duration = FieldOptions.validationDelayOnChange, validationDelayOnBlur: Duration = FieldOptions.validationDelayOnBlur): FieldOptions

Creates a FieldOptions instance with the specified configuration.

FieldValidationStrategy

fun FieldValidationStrategy(initial: FieldValidationMode = FieldValidationMode.Blur, next: (current: FieldValidationMode, isValid: Boolean) -> FieldValidationMode = defaultStrategy): FieldValidationStrategy

Creates a field validation strategy with the specified initial mode and transition logic.

inline fun <V> FieldValidator(noinline block: ValidationRuleBuilder<V>.() -> Unit): FieldValidator<V>

Creates a field validator using a validation rule builder.

fun FormOptions(preValidation: Boolean = FormOptions.preValidation, preValidationDelayOnMount: Duration = FormOptions.preValidationDelayOnMount, preValidationDelayOnChange: Duration = FormOptions.preValidationDelayOnChange): FormOptions

Creates a FormOptions instance with the specified configuration.