Open History to see the last commit
1---
2id: FieldGroupApi
3title: FieldGroupApi
4---
5β
6# Class: FieldGroupApi\<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
7β
8Defined in: [packages/form-core/src/FieldGroupApi.ts:113](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L113)
9β
10## Type Parameters
11β
12### TFormData
13β
14`TFormData`
15β
16### TFieldGroupData
17β
18`TFieldGroupData`
19β
20### TFields
21β
22`TFields` *extends*
23 \| [`DeepKeysOfType`](../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\>
24 \| [`FieldsMap`](../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\>
25β
26### TOnMount
27β
28`TOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
29β
30### TOnChange
31β
32`TOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
33β
34### TOnChangeAsync
35β
36`TOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
37β
38### TOnBlur
39β
40`TOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
41β
42### TOnBlurAsync
43β
44`TOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
45β
46### TOnSubmit
47β
48`TOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
49β
50### TOnSubmitAsync
51β
52`TOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
53β
54### TOnDynamic
55β
56`TOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
57β
58### TOnDynamicAsync
59β
60`TOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
61β
62### TOnServer
63β
64`TOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
65β
66### TSubmitMeta
67β
68`TSubmitMeta` = `never`
69β
70## Constructors
71β
72### Constructor
73β
74```ts
75new FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts): FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
76```
77β
78Defined in: [packages/form-core/src/FieldGroupApi.ts:238](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L238)
79β
80Constructs a new `FieldGroupApi` instance with the given form options.
81β
82#### Parameters
83β
84##### opts
85β
86[`FieldGroupOptions`](../interfaces/FieldGroupOptions.md)\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
87β
88#### Returns
89β
90`FieldGroupApi`\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
91β
92## Properties
93β
94### fieldsMap
95β
96```ts
97readonly fieldsMap: TFields;
98```
99β
100Defined in: [packages/form-core/src/FieldGroupApi.ts:149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L149)
101β
102***
103β
104### form
105β
106```ts
107readonly form: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
108```
109β
110Defined in: [packages/form-core/src/FieldGroupApi.ts:134](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L134)
111β
112The form that called this field group.
113β
114***
115β
116### store
117β
118```ts
119store: ReadonlyStore<FieldGroupState<TFieldGroupData>>;
120```
121β
122Defined in: [packages/form-core/src/FieldGroupApi.ts:229](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L229)
123β
124## Accessors
125β
126### state
127β
128#### Get Signature
129β
130```ts
131get state(): FieldGroupState<TFieldGroupData>;
132```
133β
134Defined in: [packages/form-core/src/FieldGroupApi.ts:231](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L231)
135β
136##### Returns
137β
138[`FieldGroupState`](../interfaces/FieldGroupState.md)\<`TFieldGroupData`\>
139β
140## Methods
141β
142### clearFieldValues()
143β
144```ts
145clearFieldValues<TField>(field, opts?): void;
146```
147β
148Defined in: [packages/form-core/src/FieldGroupApi.ts:507](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L507)
149β
150#### Type Parameters
151β
152##### TField
153β
154`TField` *extends* `string`
155β
156#### Parameters
157β
158##### field
159β
160`TField`
161β
162##### opts?
163β
164`UpdateMetaOptions`
165β
166#### Returns
167β
168`void`
169β
170#### Implementation of
171β
172```ts
173FieldManipulator.clearFieldValues
174```
175β
176***
177β
178### deleteField()
179β
180```ts
181deleteField<TField>(field): void;
182```
183β
184Defined in: [packages/form-core/src/FieldGroupApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L394)
185β
186Delete a field and its subfields.
187β
188#### Type Parameters
189β
190##### TField
191β
192`TField` *extends* `string`
193β
194#### Parameters
195β
196##### field
197β
198`TField`
199β
200#### Returns
201β
202`void`
203β
204#### Implementation of
205β
206```ts
207FieldManipulator.deleteField
208```
209β
210***
211β
212### getFieldMeta()
213β
214```ts
215getFieldMeta<TField>(field): AnyFieldMeta | undefined;
216```
217β
218Defined in: [packages/form-core/src/FieldGroupApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L362)
219β
220Gets the metadata of the specified field.
221β
222#### Type Parameters
223β
224##### TField
225β
226`TField` *extends* `string`
227β
228#### Parameters
229β
230##### field
231β
232`TField`
233β
234#### Returns
235β
236[`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md) \| `undefined`
237β
238#### Implementation of
239β
240```ts
241FieldManipulator.getFieldMeta
242```
243β
244***
245β
246### getFieldValue()
247β
248```ts
249getFieldValue<TField>(field): DeepValue<TFieldGroupData, TField>;
250```
251β
252Defined in: [packages/form-core/src/FieldGroupApi.ts:350](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L350)
253β
254Gets the value of the specified field.
255β
256#### Type Parameters
257β
258##### TField
259β
260`TField` *extends* `string`
261β
262#### Parameters
263β
264##### field
265β
266`TField`
267β
268#### Returns
269β
270[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>
271β
272#### Implementation of
273β
274```ts
275FieldManipulator.getFieldValue
276```
277β
278***
279β
280### handleSubmit()
281β
282#### Call Signature
283β
284```ts
285handleSubmit(): Promise<void>;
286```
287β
288Defined in: [packages/form-core/src/FieldGroupApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L340)
289β
290Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
291β
292##### Returns
293β
294`Promise`\<`void`\>
295β
296##### Implementation of
297β
298```ts
299FieldManipulator.handleSubmit
300```
301β
302#### Call Signature
303β
304```ts
305handleSubmit(submitMeta): Promise<void>;
306```
307β
308Defined in: [packages/form-core/src/FieldGroupApi.ts:341](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L341)
309β
310Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
311β
312##### Parameters
313β
314###### submitMeta
315β
316`TSubmitMeta`
317β
318##### Returns
319β
320`Promise`\<`void`\>
321β
322##### Implementation of
323β
324```ts
325FieldManipulator.handleSubmit
326```
327β
328***
329β
330### insertFieldValue()
331β
332```ts
333insertFieldValue<TField>(
334 field,
335 index,
336 value,
337opts?): Promise<void>;
338```
339β
340Defined in: [packages/form-core/src/FieldGroupApi.ts:419](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L419)
341β
342Insert a value into an array field at the specified index.
343β
344#### Type Parameters
345β
346##### TField
347β
348`TField` *extends* `string`
349β
350#### Parameters
351β
352##### field
353β
354`TField`
355β
356##### index
357β
358`number`
359β
360##### value
361β
362[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never`
363β
364##### opts?
365β
366`UpdateMetaOptions`
367β
368#### Returns
369β
370`Promise`\<`void`\>
371β
372#### Implementation of
373β
374```ts
375FieldManipulator.insertFieldValue
376```
377β
378***
379β
380### mount()
381β
382```ts
383mount(): () => void;
384```
385β
386Defined in: [packages/form-core/src/FieldGroupApi.ts:306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L306)
387β
388Mounts the field group instance to listen to value changes.
389β
390TODO: Remove
391β
392#### Returns
393β
394```ts
395(): void;
396```
397β
398##### Returns
399β
400`void`
401β
402***
403β
404### moveFieldValues()
405β
406```ts
407moveFieldValues<TField>(
408 field,
409 index1,
410 index2,
411 opts?): void;
412```
413β
414Defined in: [packages/form-core/src/FieldGroupApi.ts:493](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L493)
415β
416Moves the value at the first specified index to the second specified index within an array field.
417β
418#### Type Parameters
419β
420##### TField
421β
422`TField` *extends* `string`
423β
424#### Parameters
425β
426##### field
427β
428`TField`
429β
430##### index1
431β
432`number`
433β
434##### index2
435β
436`number`
437β
438##### opts?
439β
440`UpdateMetaOptions`
441β
442#### Returns
443β
444`void`
445β
446#### Implementation of
447β
448```ts
449FieldManipulator.moveFieldValues
450```
451β
452***
453β
454### pushFieldValue()
455β
456```ts
457pushFieldValue<TField>(
458 field,
459 value,
460 opts?): void;
461```
462β
463Defined in: [packages/form-core/src/FieldGroupApi.ts:401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L401)
464β
465Pushes a value into an array field.
466β
467#### Type Parameters
468β
469##### TField
470β
471`TField` *extends* `string`
472β
473#### Parameters
474β
475##### field
476β
477`TField`
478β
479##### value
480β
481[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never`
482β
483##### opts?
484β
485`UpdateMetaOptions`
486β
487#### Returns
488β
489`void`
490β
491#### Implementation of
492β
493```ts
494FieldManipulator.pushFieldValue
495```
496β
497***
498β
499### removeFieldValue()
500β
501```ts
502removeFieldValue<TField>(
503 field,
504 index,
505opts?): Promise<void>;
506```
507β
508Defined in: [packages/form-core/src/FieldGroupApi.ts:463](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L463)
509β
510Removes a value from an array field at the specified index.
511β
512#### Type Parameters
513β
514##### TField
515β
516`TField` *extends* `string`
517β
518#### Parameters
519β
520##### field
521β
522`TField`
523β
524##### index
525β
526`number`
527β
528##### opts?
529β
530`UpdateMetaOptions`
531β
532#### Returns
533β
534`Promise`\<`void`\>
535β
536#### Implementation of
537β
538```ts
539FieldManipulator.removeFieldValue
540```
541β
542***
543β
544### replaceFieldValue()
545β
546```ts
547replaceFieldValue<TField>(
548 field,
549 index,
550 value,
551opts?): Promise<void>;
552```
553β
554Defined in: [packages/form-core/src/FieldGroupApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L441)
555β
556Replaces a value into an array field at the specified index.
557β
558#### Type Parameters
559β
560##### TField
561β
562`TField` *extends* `string`
563β
564#### Parameters
565β
566##### field
567β
568`TField`
569β
570##### index
571β
572`number`
573β
574##### value
575β
576[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never`
577β
578##### opts?
579β
580`UpdateMetaOptions`
581β
582#### Returns
583β
584`Promise`\<`void`\>
585β
586#### Implementation of
587β
588```ts
589FieldManipulator.replaceFieldValue
590```
591β
592***
593β
594### resetField()
595β
596```ts
597resetField<TField>(field): void;
598```
599β
600Defined in: [packages/form-core/src/FieldGroupApi.ts:517](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L517)
601β
602Resets the field value and meta to default state
603β
604#### Type Parameters
605β
606##### TField
607β
608`TField` *extends* `string`
609β
610#### Parameters
611β
612##### field
613β
614`TField`
615β
616#### Returns
617β
618`void`
619β
620#### Implementation of
621β
622```ts
623FieldManipulator.resetField
624```
625β
626***
627β
628### setFieldMeta()
629β
630```ts
631setFieldMeta<TField>(field, updater): void;
632```
633β
634Defined in: [packages/form-core/src/FieldGroupApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L369)
635β
636Updates the metadata of the specified field.
637β
638#### Type Parameters
639β
640##### TField
641β
642`TField` *extends* `string`
643β
644#### Parameters
645β
646##### field
647β
648`TField`
649β
650##### updater
651β
652[`Updater`](../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../type-aliases/AnyFieldMetaBase.md)\>
653β
654#### Returns
655β
656`void`
657β
658#### Implementation of
659β
660```ts
661FieldManipulator.setFieldMeta
662```
663β
664***
665β
666### setFieldValue()
667β
668```ts
669setFieldValue<TField>(
670 field,
671 updater,
672 opts?): void;
673```
674β
675Defined in: [packages/form-core/src/FieldGroupApi.ts:379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L379)
676β
677Sets the value of the specified field and optionally updates the touched state.
678β
679#### Type Parameters
680β
681##### TField
682β
683`TField` *extends* `string`
684β
685#### Parameters
686β
687##### field
688β
689`TField`
690β
691##### updater
692β
693[`Updater`](../type-aliases/Updater.md)\<[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\>
694β
695##### opts?
696β
697`UpdateMetaOptions`
698β
699#### Returns
700β
701`void`
702β
703#### Implementation of
704β
705```ts
706FieldManipulator.setFieldValue
707```
708β
709***
710β
711### swapFieldValues()
712β
713```ts
714swapFieldValues<TField>(
715 field,
716 index1,
717 index2,
718 opts?): void;
719```
720β
721Defined in: [packages/form-core/src/FieldGroupApi.ts:476](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L476)
722β
723Swaps the values at the specified indices within an array field.
724β
725#### Type Parameters
726β
727##### TField
728β
729`TField` *extends* `string`
730β
731#### Parameters
732β
733##### field
734β
735`TField`
736β
737##### index1
738β
739`number`
740β
741##### index2
742β
743`number`
744β
745##### opts?
746β
747`UpdateMetaOptions`
748β
749#### Returns
750β
751`void`
752β
753#### Implementation of
754β
755```ts
756FieldManipulator.swapFieldValues
757```
758β
759***
760β
761### validateAllFields()
762β
763```ts
764validateAllFields(cause): Promise<unknown[]>;
765```
766β
767Defined in: [packages/form-core/src/FieldGroupApi.ts:521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L521)
768β
769#### Parameters
770β
771##### cause
772β
773`ValidationCause`
774β
775#### Returns
776β
777`Promise`\<`unknown`[]\>
778β
779#### Implementation of
780β
781```ts
782FieldManipulator.validateAllFields
783```
784β
785***
786β
787### validateArrayFieldsStartingFrom()
788β
789```ts
790validateArrayFieldsStartingFrom<TField>(
791 field,
792 index,
793cause): Promise<unknown[]>;
794```
795β
796Defined in: [packages/form-core/src/FieldGroupApi.ts:313](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L313)
797β
798Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
799β
800#### Type Parameters
801β
802##### TField
803β
804`TField` *extends* `string`
805β
806#### Parameters
807β
808##### field
809β
810`TField`
811β
812##### index
813β
814`number`
815β
816##### cause
817β
818`ValidationCause`
819β
820#### Returns
821β
822`Promise`\<`unknown`[]\>
823β
824#### Implementation of
825β
826```ts
827FieldManipulator.validateArrayFieldsStartingFrom
828```
829β
830***
831β
832### validateField()
833β
834```ts
835validateField<TField>(field, cause): any[] | Promise<any[]>;
836```
837β
838Defined in: [packages/form-core/src/FieldGroupApi.ts:330](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L330)
839β
840Validates a specified field in the form using the correct handlers for a given validation type.
841β
842#### Type Parameters
843β
844##### TField
845β
846`TField` *extends* `string`
847β
848#### Parameters
849β
850##### field
851β
852`TField`
853β
854##### cause
855β
856`ValidationCause`
857β
858#### Returns
859β
860`any`[] \| `Promise`\<`any`[]\>
861β
862#### Implementation of
863β
864```ts
865FieldManipulator.validateField
866```