Options that can be specified when submitting a form.
API
interface FormSubmitOptions<TModel> { action: (form: FieldTree<TModel>) => Promise<TreeValidationResult>; onInvalid?: ((form: FieldTree<TModel>) => void) | undefined; ignoreValidators?: "pending" | "none" | "all" | undefined;}
action
(form: FieldTree<TModel>) => Promise<TreeValidationResult>Function to run when submitting the form data (when form is valid).
onInvalid
((form: FieldTree<TModel>) => void) | undefinedFunction to run when attempting to submit the form data but validation is failing.
ignoreValidators
"pending" | "none" | "all" | undefinedWhether to ignore any of the validators when submitting:
- 'pending': Will submit if there are no invalid validators, pending validators do not block submission (default)
- 'none': Will not submit unless all validators are passing, pending validators block submission
- 'ignore': Will always submit regardless of invalid or pending validators
Jump to details