TanStack

FormGroupSubmitInvalidContext

Interface: FormGroupSubmitInvalidContext<TFormData, TGroupName, TGroupValue, TGroupErrorTypes, TFormErrorTypes>

Defined in: FormGroupApi/FormGroupApi.public.ts:79

Context passed to a form group's onSubmitInvalid when submission fails.

Example

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

Type Parameters

TFormData

TFormData

TGroupName

TGroupName

TGroupValue

TGroupValue

TGroupErrorTypes

TGroupErrorTypes extends FormErrorTypes

TFormErrorTypes

TFormErrorTypes extends FormErrorTypes

Properties

formApi

ts
formApi: FormApi<TFormData, TFormErrorTypes>;

Defined in: FormGroupApi/FormGroupApi.public.ts:89

The parent form API handling the failed submission.


groupApi

ts
groupApi: FormGroupApi<TFormData, TGroupName, TGroupValue, TGroupErrorTypes, TFormErrorTypes>;

Defined in: FormGroupApi/FormGroupApi.public.ts:91

The group API handling the failed submission.


value

ts
value: TGroupValue;

Defined in: FormGroupApi/FormGroupApi.public.ts:87

The group values for the failed submission.