Interface: FormOptions<TFormData, TFormValidators, TSubmitReturn>#

Defined in: FormApi/FormApi.public.ts:147

Type Parameters#

TFormData#

TFormData

TFormValidators#

TFormValidators extends FormValidators<TFormData>

TSubmitReturn#

TSubmitReturn

Properties#

defaultValues#

defaultValues: TFormData;

Defined in: FormApi/FormApi.public.ts:153

errorVisibility?#

optional errorVisibility?: ErrorVisibility<TFormData, ToFormErrorTypes<TFormValidators, unknown>>;

Defined in: FormApi/FormApi.public.ts:154

formId?#

optional formId?: string;

Defined in: FormApi/FormApi.public.ts:152

listeners?#

optional listeners?: FormListeners<TFormData, ToFormErrorTypes<TFormValidators, unknown>>;

Defined in: FormApi/FormApi.public.ts:159

onSubmit?#

optional onSubmit?: (context) => TSubmitReturn;

Defined in: FormApi/FormApi.public.ts:183

Called after submission validation succeeds.

Return an error created with createValidationError or parseIssues to mark the submission as invalid.

Parameters#

context#

FormSubmitContext<TFormData, ToFormSchemaOutputs<TFormValidators>, ToFormErrorTypes<TFormValidators, unknown>>

Returns#

TSubmitReturn

Example#

{
  // ...
  onSubmit: async ({ value }) => {
    await saveUser(value)
  },
}

onSubmitInvalid?#

optional onSubmitInvalid?: (context) => void | Promise<void>;

Defined in: FormApi/FormApi.public.ts:206

Called when validation fails, onSubmit returns an error, or validation or submission throws. The callback is awaited before submission finishes.

Parameters#

context#

FormSubmitInvalidContext<TFormData, ToFormErrorTypes<TFormValidators, unknown>>

Returns#

void | Promise<void>

Example#

{
  // ...
  onSubmitInvalid: () => {
    document
      .querySelector<HTMLElement>('[aria-invalid="true"]')
      ?.focus()
  },
}

serverState?#

optional serverState?: 
  | ServerFormState<NoInfer<TFormData>, NoInfer<TFormValidators>>
  | null;

Defined in: FormApi/FormApi.public.ts:163

validators?#

optional validators?: TFormValidators;

Defined in: FormApi/FormApi.public.ts:158