Open History to see the last commit
1---
2id: FormGroupSubmitContext
3title: FormGroupSubmitContext
4---
5β
6Defined in: [FormGroupApi/FormGroupApi.public.ts:26](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L26)
7β
8Context passed to a form group's `onSubmit` after group validation succeeds.
9β
10## Example
11β
12```ts
13{
14 // ...
15 onSubmit: async ({ value }) => {
16 await saveGuestDetails(value)
17 },
18}
19```
20β
21## Type Parameters
22β
23### TFormData
24β
25`TFormData`
26β
27### TGroupName
28β
29`TGroupName`
30β
31### TGroupValue
32β
33`TGroupValue`
34β
35### TOutputs
36β
37`TOutputs`
38β
39### TGroupErrorTypes
40β
41`TGroupErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
42β
43### TFormErrorTypes
44β
45`TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
46β
47## Properties
48β
49### formApi
50β
51```ts
52formApi: FormApi<TFormData, TFormErrorTypes>;
53```
54β
55Defined in: [FormGroupApi/FormGroupApi.public.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L37)
56β
57The parent form API handling this submission.
58β
59***
60β
61### groupApi
62β
63```ts
64groupApi: FormGroupApi<TFormData, TGroupName, TGroupValue, TGroupErrorTypes, TFormErrorTypes>;
65```
66β
67Defined in: [FormGroupApi/FormGroupApi.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L39)
68β
69The group API handling this submission.
70β
71***
72β
73### validatorOutputs
74β
75```ts
76validatorOutputs: TOutputs;
77```
78β
79Defined in: [FormGroupApi/FormGroupApi.public.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L62)
80β
81Schema outputs and `createOutput` payloads from this group submission,
82ordered by validator index. Skipped validators and successful returns
83without an output contribute `undefined`.
84β
85#### Example
86β
87```ts
88{
89 // ...
90 onSubmit: async ({ validatorOutputs }) => {
91 const validatedGuestDetails = validatorOutputs[0]
92 setStep(step => step + 1)
93 },
94}
95```
96β
97***
98β
99### value
100β
101```ts
102value: TGroupValue;
103```
104β
105Defined in: [FormGroupApi/FormGroupApi.public.ts:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L35)
106β
107The group values for this submission.