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

useFieldGroup.md

109 lines3.0 KB

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`\>