Open History to see the last commit
1---
2id: useFieldGroup
3title: useFieldGroup
4---
5β
6# Function: useFieldGroup()
7β
8```ts
9function useFieldGroup<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TComponents, TFormComponents, TSubmitMeta>(opts): AppFieldExtendedReactFieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;
10```
11β
12Defined in: [packages/react-form/src/useFieldGroup.tsx:96](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L96)
13β
14## Type Parameters
15β
16### TFormData
17β
18`TFormData`
19β
20### TFieldGroupData
21β
22`TFieldGroupData`
23β
24### TFields
25β
26`TFields` *extends*
27 \| `string`
28 \| \{ \[K in string \| number \| symbol\]: DeepKeysOfType\<TFormData, TFieldGroupData\[K\]\> \}
29β
30### TOnMount
31β
32`TOnMount` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
33β
34### TOnChange
35β
36`TOnChange` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
37β
38### TOnChangeAsync
39β
40`TOnChangeAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
41β
42### TOnBlur
43β
44`TOnBlur` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
45β
46### TOnBlurAsync
47β
48`TOnBlurAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
49β
50### TOnSubmit
51β
52`TOnSubmit` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
53β
54### TOnSubmitAsync
55β
56`TOnSubmitAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
57β
58### TOnDynamic
59β
60`TOnDynamic` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
61β
62### TOnDynamicAsync
63β
64`TOnDynamicAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
65β
66### TOnServer
67β
68`TOnServer` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
69β
70### TComponents
71β
72`TComponents` *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
73β
74### TFormComponents
75β
76`TFormComponents` *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
77β
78### TSubmitMeta
79β
80`TSubmitMeta` = `never`
81β
82## Parameters
83β
84### opts
85β
86#### defaultValues?
87β
88`TFieldGroupData`
89β
90#### fields
91β
92`TFields`
93β
94#### form
95β
96 \| `AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
97 \| `AppFieldExtendedReactFieldGroupApi`\<`unknown`, `TFormData`, `string` \| `FieldsMap`\<`unknown`, `TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
98β
99#### formComponents
100β
101`TFormComponents`
102β
103#### onSubmitMeta?
104β
105`TSubmitMeta`
106β
107## Returns
108β
109`AppFieldExtendedReactFieldGroupApi`\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>