Open History to see the last commit
1---
2id: FormGroupApi
3title: FormGroupApi
4---
5β
6Defined in: [FormGroupApi/FormGroupApi.public.ts:195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L195)
7β
8## Type Parameters
9β
10### TFormData
11β
12`TFormData`
13β
14### TGroupName
15β
16`TGroupName`
17β
18### TGroupValue
19β
20`TGroupValue`
21β
22### TGroupErrorTypes
23β
24`TGroupErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
25β
26### TFormErrorTypes
27β
28`TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
29β
30## Properties
31β
32### atom
33β
34```ts
35atom: ReadonlyAtom<FormGroupState<TGroupValue, TGroupErrorTypes>>;
36```
37β
38Defined in: [FormGroupApi/FormGroupApi.public.ts:205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L205)
39β
40***
41β
42### form
43β
44```ts
45readonly form: FormApi<TFormData, TFormErrorTypes>;
46```
47β
48Defined in: [FormGroupApi/FormGroupApi.public.ts:202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L202)
49β
50***
51β
52### handleSubmit
53β
54```ts
55handleSubmit: () => Promise<FormGroupValidateResult<TGroupValue>[]>;
56```
57β
58Defined in: [FormGroupApi/FormGroupApi.public.ts:211](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L211)
59β
60#### Returns
61β
62`Promise`\<[`FormGroupValidateResult`](../type-aliases/FormGroupValidateResult.md)\<`TGroupValue`\>[]\>
63β
64***
65β
66### name
67β
68```ts
69readonly name: TGroupName;
70```
71β
72Defined in: [FormGroupApi/FormGroupApi.public.ts:203](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L203)
73β
74***
75β
76### reset
77β
78```ts
79reset: () => void;
80```
81β
82Defined in: [FormGroupApi/FormGroupApi.public.ts:212](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L212)
83β
84#### Returns
85β
86`void`
87β
88***
89β
90### state
91β
92```ts
93readonly state: FormGroupState<TGroupValue, TGroupErrorTypes>;
94```
95β
96Defined in: [FormGroupApi/FormGroupApi.public.ts:206](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L206)
97β
98***
99β
100### validate
101β
102```ts
103validate: (signal) => Promise<FormGroupValidateResult<TGroupValue>[]>;
104```
105β
106Defined in: [FormGroupApi/FormGroupApi.public.ts:208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L208)
107β
108#### Parameters
109β
110##### signal
111β
112 \| `"submit"`
113 \| [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md)
114β
115#### Returns
116β
117`Promise`\<[`FormGroupValidateResult`](../type-aliases/FormGroupValidateResult.md)\<`TGroupValue`\>[]\>
118β
119***
120β
121### value
122β
123```ts
124readonly value: TGroupValue;
125```
126β
127Defined in: [FormGroupApi/FormGroupApi.public.ts:207](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L207)