soil-form/soil.form.compose/FieldControl

FieldControl

class FieldControl<V>(val name: FieldName, val policy: FieldPolicy, val rule: FormRule<V>, val defaultValue: V, val getValue: () -> V, val setValue: (V) -> Unit, val getErrors: () -> FieldErrors, val setErrors: (FieldErrors) -> Unit, val shouldTrigger: (FieldValidateOn) -> Boolean, val isEnabled: () -> Boolean)

Represents a field control in a form.

Parameters

V

The type of the field value.

Constructors

constructor(name: FieldName, policy: FieldPolicy, rule: FormRule<V>, defaultValue: V, getValue: () -> V, setValue: (V) -> Unit, getErrors: () -> FieldErrors, setErrors: (FieldErrors) -> Unit, shouldTrigger: (FieldValidateOn) -> Boolean, isEnabled: () -> Boolean)

Properties

val defaultValue: V

The default value of the field.

val getErrors: () -> FieldErrors

The function to get the current field errors.

val getValue: () -> V

The function to get the current field value.

val isEnabled: () -> Boolean

The function to determine if the field is enabled.

val name: FieldName

The name of the field.

val policy: FieldPolicy

The policy of the field.

val rule: FormRule<V>

The rule to validate the field value.

val setErrors: (FieldErrors) -> Unit

The function to set the new field errors. If the new errors are empty, the field is considered valid.

val setValue: (V) -> Unit

The function to set the new field value.

val shouldTrigger: (FieldValidateOn) -> Boolean

The function to determine if the field should trigger validation on the given event.

Functions

fun validate(value: V = getValue(), dryRun: Boolean = false): Boolean

Validates the field value.