data class ~~FieldPolicy~~(val validationTrigger: FieldValidationTrigger = FieldValidationTrigger, val validationDelay: FieldValidationDelay = FieldValidationDelay())

Represents the settings for field-related policies, such as validation behavior.

FieldTypeAdapter

interface FieldTypeAdapter<V, S, U>

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

FieldValidateOn

enum ~~FieldValidateOn~~ : Enum<FieldValidateOn>

Enumerates the timings when field validation is performed.

FieldValidationDelay

data class ~~FieldValidationDelay~~(val onMount: Duration = Duration.ZERO, val onChange: Duration = 250.milliseconds, val onBlur: Duration = Duration.ZERO)

Represents the settings for delayed execution of field validation.

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.

FieldValidationTrigger

interface ~~FieldValidationTrigger~~

Represents the timings that trigger field validation.

FieldValidator

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

A type alias for field validation functions.

FormData

interface FormData<T>

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

FormErrors

typealias ~~FormErrors~~ = Map<FieldName, FieldErrors>

FormFieldDependencies

typealias ~~FormFieldDependencies~~ = Map<FieldName, FormFieldNames>

FormFieldNames

typealias ~~FormFieldNames~~ = Set<FieldName>

FormMeta

interface FormMeta

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

FormOptions

interface FormOptions

Configuration options for form-level validation behavior.

FormPolicy

data class ~~FormPolicy~~(val field: FieldPolicy = FieldPolicy(), val submission: SubmissionPolicy = SubmissionPolicy())

Represents the settings for the overall form policy.

FormRule

fun interface ~~FormRule~~<T>

Represents a rule that can be applied to a form field.

FormRules

typealias ~~FormRules<T>~~ = Map<FieldName, FormRule<T>>

FormTriggers

typealias ~~FormTriggers~~ = Map<FieldName, FieldValidateOn>

FormValidationException

class ~~FormValidationException~~(val errors: FormErrors, cause: Throwable? = null) : RuntimeException

Exception used for handling validation errors during the submission process.

Submission

interface ~~Submission~~

A submission represents the submission control of a form.

SubmissionPolicy

data class ~~SubmissionPolicy~~(val preValidation: Boolean = true, val preValidationDelay: SubmissionPreValidationDelay = SubmissionPreValidationDelay())

Represents the settings for submission-related policies, such as pre-validation behavior.

SubmissionPreValidationDelay

data class ~~SubmissionPreValidationDelay~~(val onMount: Duration = 200.milliseconds, val onChange: Duration = 200.milliseconds)

Represents the settings for delayed execution of pre-validation.

Properties

noErrors

val ~~noErrors~~: FieldErrors

Syntax sugar representing that there are no errors in the field.

noFieldError

val noFieldError: FieldError

A constant representing no validation errors.

Functions

fieldError

fun ~~fieldError~~(vararg messages: String): FieldErrors

Creates error messages for a field.

FieldOptions

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.

FieldValidator

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

Creates a field validator using a validation rule builder.

FormOptions

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

Creates a FormOptions instance with the specified configuration.