Open History to see the last commit
1---
2id: FormGroupOptions
3title: FormGroupOptions
4---
5β
6Defined in: [FormGroupApi/FormGroupApi.public.ts:118](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L118)
7β
8## Type Parameters
9β
10### TFormData
11β
12`TFormData`
13β
14### TGroupName
15β
16`TGroupName`
17β
18### TGroupValue
19β
20`TGroupValue`
21β
22### TGroupValidators
23β
24`TGroupValidators` *extends* [`FormGroupValidators`](../type-aliases/FormGroupValidators.md)\<`TGroupValue`\>
25β
26### TFormErrorTypes
27β
28`TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
29β
30## Properties
31β
32### form
33β
34```ts
35form: FormApi<TFormData, TFormErrorTypes>;
36```
37β
38Defined in: [FormGroupApi/FormGroupApi.public.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L125)
39β
40***
41β
42### name
43β
44```ts
45name: TGroupName;
46```
47β
48Defined in: [FormGroupApi/FormGroupApi.public.ts:126](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L126)
49β
50***
51β
52### onSubmit?
53β
54```ts
55optional onSubmit?: FormGroupSubmitFn<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormErrorTypes>;
56```
57β
58Defined in: [FormGroupApi/FormGroupApi.public.ts:142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L142)
59β
60Called after group submission validation succeeds. The callback is awaited
61before submission finishes.
62β
63#### Example
64β
65```ts
66{
67 // ...
68 onSubmit: () => {
69 setStep(step => step + 1)
70 },
71}
72```
73β
74***
75β
76### onSubmitInvalid?
77β
78```ts
79optional onSubmitInvalid?: (context) => void | Promise<void>;
80```
81β
82Defined in: [FormGroupApi/FormGroupApi.public.ts:165](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L165)
83β
84Called when group validation fails or validation or submission throws. The
85callback is awaited before submission finishes.
86β
87#### Parameters
88β
89##### context
90β
91[`FormGroupSubmitInvalidContext`](FormGroupSubmitInvalidContext.md)\<`TFormData`, `TGroupName`, `TGroupValue`, [`ToFormGroupErrorTypes`](../type-aliases/ToFormGroupErrorTypes.md)\<`NoInfer`\<`TGroupValidators`\>\>, `TFormErrorTypes`\>
92β
93#### Returns
94β
95`void` \| `Promise`\<`void`\>
96β
97#### Example
98β
99```ts
100{
101 // ...
102 onSubmitInvalid: ({ groupApi }) => {
103 document
104 .querySelector<HTMLElement>('[aria-invalid="true"]')
105 ?.focus()
106 },
107}
108```
109β
110***
111β
112### validators?
113β
114```ts
115optional validators?: TGroupValidators;
116```
117β
118Defined in: [FormGroupApi/FormGroupApi.public.ts:127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L127)