soil-form/soil.form

Package-level declarations

Types

interface Field<V>

A field is a single input in a form. It has a name, a value, and a set of errors.

typealias FieldError = String

Represents a single error message in the field.

typealias FieldErrors = List<FieldError>

Represents multiple error messages in the field.

typealias FieldName = String

This field name is used to uniquely identify a field within a form.

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

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

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.

FieldValidationTrigger

interface FieldValidationTrigger

Represents the timings that trigger field validation.

typealias FormErrors = Map<FieldName, FieldErrors>

FormFieldDependencies

typealias FormFieldDependencies = Map<FieldName, FormFieldNames>

typealias FormFieldNames = Set<FieldName>

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

Represents the settings for the overall form policy.

fun interface FormRule<T>

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

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

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.

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.

fun interface ValidationRule<V>

Represents a validation rule for a form field.

ValidationRuleBuilder

class ValidationRuleBuilder<V>

Builder for creating a set of validation rules.

ValidationRuleSet

typealias ValidationRuleSet<V> = Set<ValidationRule<V>>

A set of validation rules.

Properties

val noErrors: FieldErrors

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

Functions

fun fieldError(vararg messages: String): FieldErrors

Creates error messages for a field.

fun <V> rules(block: ValidationRuleBuilder<V>.() -> Unit): ValidationRuleSet<V>

Creates a set of validation rules.