FormSubmitOptions - Angular

Options that can be specified when submitting a form.

API

interface FormSubmitOptions<TRootModel, TSubmittedModel> {
  action: (field: FieldTree<TRootModel & TSubmittedModel, string | number>, detail: { root: FieldTree<TRootModel, string | number>; submitted: FieldTree<TSubmittedModel, string | number>; }) => Promise<TreeValidationResult<WithOptionalFieldTree>>;
  onInvalid?: ((field: FieldTree<TRootModel & TSubmittedModel, string | number>, detail: { root: FieldTree<TRootModel, string | number>; submitted: FieldTree<TSubmittedModel, string | number>; }) => void) | undefined;
  ignoreValidators?: "pending" | "none" | "all" | undefined;
}

action

(field: FieldTree<TRootModel & TSubmittedModel, string | number>, detail: { root: FieldTree<TRootModel, string | number>; submitted: FieldTree<TSubmittedModel, string | number>; }) => Promise<TreeValidationResult<WithOptionalFieldTree>>

Function to run when submitting the form data (when form is valid).

onInvalid

((field: FieldTree<TRootModel & TSubmittedModel, string | number>, detail: { root: FieldTree<TRootModel, string | number>; submitted: FieldTree<TSubmittedModel, string | number>; }) => void) | undefined

Function to run when attempting to submit the form data but validation is failing.

ignoreValidators

"pending" | "none" | "all" | undefined

Whether 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