Open History to see the last commit
1---
2id: FormGroupValidator
3title: FormGroupValidator
4---
5β
6Defined in: [validation.public.ts:918](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L918)
7β
8Configures validation of a form group's value.
9β
10## Extends
11β
12- [`Validator`](Validator.md)\<`TGroupValue`,
13 \| [`FormGroupValidatorFn`](../type-aliases/FormGroupValidatorFn.md)\<`TGroupValue`\>
14 \| [`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TGroupValue`, `any`\>, `TGroupValue`, [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md), `"group"`\>
15β
16## Type Parameters
17β
18### TGroupValue
19β
20`TGroupValue`
21β
22Library-managed. Do not specify explicitly.
23β
24## Properties
25β
26### bailIfInvalid?
27β
28```ts
29optional bailIfInvalid?: boolean;
30```
31β
32Defined in: [validation.public.ts:29](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L29)
33β
34If `true`, skips this and subsequent validators when earlier validation has failed.
35β
36If `false`, earlier failures do not prevent this validator from running.
37β
38#### Default
39β
40```ts
41false
42```
43β
44#### Inherited from
45β
46[`Validator`](Validator.md).[`bailIfInvalid`](Validator.md#bailifinvalid)
47β
48***
49β
50### run
51β
52```ts
53run:
54 | FormGroupValidatorFn<TGroupValue>
55| StandardSchemaV1<TGroupValue, any>;
56```
57β
58Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21)
59β
60The function or Standard Schema that validates the value in this validator's scope.
61β
62#### Inherited from
63β
64[`Validator`](Validator.md).[`run`](Validator.md#run)
65β
66***
67β
68### runOnMount?
69β
70```ts
71optional runOnMount?: boolean;
72```
73β
74Defined in: [validation.public.ts:64](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L64)
75β
76Whether this validator runs when the form is constructed or when its field
77or form group first mounts.
78β
79#### Default
80β
81```ts
82false
83```
84β
85#### Inherited from
86β
87[`Validator`](Validator.md).[`runOnMount`](Validator.md#runonmount)
88β
89***
90β
91### skipOnSubmit?
92β
93```ts
94optional skipOnSubmit?:
95 | boolean
96| ValidationPredicateFn<TGroupValue, TGroupValue, "group">;
97```
98β
99Defined in: [validation.public.ts:56](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L56)
100β
101Whether this validator runs during a submission attempt, independently of `triggers`.
102β
103Pass a boolean directly, or pass a function that returns
104`true` to skip it for the current attempt.
105β
106#### Default
107β
108```ts
109false
110```
111β
112#### Inherited from
113β
114[`Validator`](Validator.md).[`skipOnSubmit`](Validator.md#skiponsubmit)
115β
116***
117β
118### triggerDebounceMs?
119β
120```ts
121optional triggerDebounceMs?:
122 | number
123| ValidationDebounceFn<TGroupValue, TGroupValue, "group">;
124```
125β
126Defined in: [validation.public.ts:74](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L74)
127β
128The delay in milliseconds before validation runs for change or blur events.
129β
130Pass a number for a fixed delay, or pass a function that returns the delay
131for the current event. Repeated events restart the delay.
132Submission validation runs immediately.
133β
134#### Default
135β
136```ts
1370
138```
139β
140#### Inherited from
141β
142[`Validator`](Validator.md).[`triggerDebounceMs`](Validator.md#triggerdebouncems)
143β
144***
145β
146### triggers
147β
148```ts
149triggers: ValidationTriggerOption<TGroupValue, TGroupValue, ConfigurableValidationTrigger, "group">[];
150```
151β
152Defined in: [validation.public.ts:82](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L82)
153β
154Change and blur events that can run this validator, optionally with conditions.
155β
156An empty array disables change and blur validation. Configure submission
157separately with `skipOnSubmit` and initial validation with `runOnMount`.
158β
159#### Inherited from
160β
161[`Validator`](Validator.md).[`triggers`](Validator.md#triggers)