Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FormGroupSubmitContext.md

106 lines2.0 KB

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

Context passed to a form group's onSubmit after group validation succeeds.

Example

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

Type Parameters

TFormData

TFormData

TGroupName

TGroupName

TGroupValue

TGroupValue

TSchemaOutputs

TSchemaOutputs

TGroupErrorTypes

TGroupErrorTypes extends FormErrorTypes

TFormErrorTypes

TFormErrorTypes extends FormErrorTypes

Properties

formApi

formApi: FormApi<TFormData, TFormErrorTypes>;

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

The parent form API handling this submission.


groupApi

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

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

The group API handling this submission.


schemaOutputs

schemaOutputs: TSchemaOutputs;

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

The submit outputs produced by the group's schema validators, ordered by validator index.

Example

{
  // ...
  onSubmit: async ({ schemaOutputs }) => {
    const validatedGuestDetails = schemaOutputs[0]
    setStep(step => step + 1)
  },
}

value

value: TGroupValue;

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

The group values for this submission.