soil-form/soil.form.compose/SubmissionControl

SubmissionControl

class SubmissionControl<T>(val policy: SubmissionPolicy, val rule: FormRule<T>, val submit: () -> Unit, val initialValue: T, val getValue: () -> T, val hasError: () -> Boolean, val getFieldKeys: () -> FormFieldNames, val isSubmitting: () -> Boolean, val isSubmitted: () -> Boolean, val getSubmitCount: () -> Int)

Represents a submission control in a form.

Parameters

T

The type of the form value.

Constructors

SubmissionControl

constructor(policy: SubmissionPolicy, rule: FormRule<T>, submit: () -> Unit, initialValue: T, getValue: () -> T, hasError: () -> Boolean, getFieldKeys: () -> FormFieldNames, isSubmitting: () -> Boolean, isSubmitted: () -> Boolean, getSubmitCount: () -> Int)

Creates a submission control.

Properties

val getFieldKeys: () -> FormFieldNames

The function to get the keys of the form fields.

val getSubmitCount: () -> Int

The function to get the number of times submission process was called.

val getValue: () -> T

The function to get the current form value.

val hasError: () -> Boolean

The function to determine if the form has errors.

val initialValue: T

The initial value of the form.

val isSubmitted: () -> Boolean

The function to determine if the form has been submitted.

val isSubmitting: () -> Boolean

The function to determine if the form is currently submitting.

val policy: SubmissionPolicy

The policy of the submission.

val rule: FormRule<T>

The rule to validate the form value.

val submit: () -> Unit

The function to submit the form.

Functions

fun validate(value: T, dryRun: Boolean = false): Boolean

Validates the form value.