Interface FormOptions

Describes the form's customization.

Type parameters

Type parameter Description
TInputs: InputGroupContent
TActionResult
TActionProgress

action

action: TaskAction<InferInputGroupValue<TInputs>, TActionResult, TActionProgress>

Specify the submit action. The outcome of this action will be saved in the submit result state.

autoConfirm

autoConfirm: undefined | false | true

If true, an attempt to submit the form will cause all of the form's inputs to be marked as confirmed. The presentataional layer can then act on this information accordingly by e.g. showing all invalid inputs in invalid state.

autoNext

autoNext: undefined | false | true

If true, confirming an input within this form will cause focusing in the next input.

autoSubmit

autoSubmit: undefined | false | true

If true, confirming an input within this form when all other confirms are confirmed and conclusively valid will result in the form being submitted.

initialProgress

initialProgress: TActionProgress

Specify the submit action's initial progress.

name

name: undefined | string

Debug-friendly name that can be back-queried from the state instance.

Generated using TypeDoc