Open History to see the last commit
1---
2id: FieldGroupOptions
3title: FieldGroupOptions
4---
5β
6# Interface: FieldGroupOptions\<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
7β
8Defined in: [packages/form-core/src/FieldGroupApi.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L50)
9β
10An object representing the options for a field group.
11β
12## Type Parameters
13β
14### TFormData
15β
16`TFormData`
17β
18### TFieldGroupData
19β
20`TFieldGroupData`
21β
22### TFields
23β
24`TFields` *extends*
25 \| [`DeepKeysOfType`](../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\>
26 \| [`FieldsMap`](../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\>
27β
28### TOnMount
29β
30`TOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
31β
32### TOnChange
33β
34`TOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
35β
36### TOnChangeAsync
37β
38`TOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
39β
40### TOnBlur
41β
42`TOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
43β
44### TOnBlurAsync
45β
46`TOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
47β
48### TOnSubmit
49β
50`TOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
51β
52### TOnSubmitAsync
53β
54`TOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
55β
56### TOnDynamic
57β
58`TOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
59β
60### TOnDynamicAsync
61β
62`TOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
63β
64### TOnServer
65β
66`TOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
67β
68### TSubmitMeta
69β
70`TSubmitMeta` = `never`
71β
72## Properties
73β
74### defaultValues?
75β
76```ts
77optional defaultValues: TFieldGroupData;
78```
79β
80Defined in: [packages/form-core/src/FieldGroupApi.ts:106](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L106)
81β
82The expected subsetValues that the form must provide.
83β
84***
85β
86### fields
87β
88```ts
89fields: TFields;
90```
91β
92Defined in: [packages/form-core/src/FieldGroupApi.ts:102](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L102)
93β
94The path to the field group data.
95β
96***
97β
98### form
99β
100```ts
101form:
102 | FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
103| FieldGroupApi<any, TFormData, any, any, any, any, any, any, any, any, any, any, any, TSubmitMeta>;
104```
105β
106Defined in: [packages/form-core/src/FieldGroupApi.ts:68](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L68)
107β
108***
109β
110### onSubmitMeta?
111β
112```ts
113optional onSubmitMeta: TSubmitMeta;
114```
115β
116Defined in: [packages/form-core/src/FieldGroupApi.ts:110](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L110)
117β
118onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props