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

FieldValidators.md

260 lines6.0 KB

1---
2id: FieldValidators
3title: FieldValidators
4---
5​
6# Interface: FieldValidators\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync\>
7​
8Defined in: [packages/form-core/src/FieldApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L287)
9​
10## Type Parameters
11​
12### TParentData
13​
14`TParentData`
15​
16### TName
17​
18`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
19​
20### TData
21​
22`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\>
23​
24### TOnMount
25​
26`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
27​
28### TOnChange
29​
30`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31​
32### TOnChangeAsync
33​
34`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35​
36### TOnBlur
37​
38`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39​
40### TOnBlurAsync
41​
42`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43​
44### TOnSubmit
45​
46`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
47​
48### TOnSubmitAsync
49​
50`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
51​
52### TOnDynamic
53​
54`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
55​
56### TOnDynamicAsync
57​
58`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
59​
60## Properties
61​
62### onBlur?
63​
64```ts
65optional onBlur: TOnBlur;
66```
67​
68Defined in: [packages/form-core/src/FieldApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L340)
69​
70An optional function, that runs on the blur event of input.
71​
72#### Example
73​
74```ts
75z.string().min(1)
76```
77​
78***
79​
80### onBlurAsync?
81​
82```ts
83optional onBlurAsync: TOnBlurAsync;
84```
85​
86Defined in: [packages/form-core/src/FieldApi.ts:346](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L346)
87​
88An optional property similar to `onBlur` but async validation.
89​
90#### Example
91​
92```ts
93z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
94```
95​
96***
97​
98### onBlurAsyncDebounceMs?
99​
100```ts
101optional onBlurAsyncDebounceMs: number;
102```
103​
104Defined in: [packages/form-core/src/FieldApi.ts:353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L353)
105​
106An optional number to represent how long the `onBlurAsync` should wait before running
107​
108If set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds
109​
110***
111​
112### onBlurListenTo?
113​
114```ts
115optional onBlurListenTo: DeepKeys<TParentData>[];
116```
117​
118Defined in: [packages/form-core/src/FieldApi.ts:357](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L357)
119​
120An optional list of field names that should trigger this field's `onBlur` and `onBlurAsync` events when its value changes
121​
122***
123​
124### onChange?
125​
126```ts
127optional onChange: TOnChange;
128```
129​
130Defined in: [packages/form-core/src/FieldApi.ts:318](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L318)
131​
132An optional function, that runs on the change event of input.
133​
134#### Example
135​
136```ts
137z.string().min(1)
138```
139​
140***
141​
142### onChangeAsync?
143​
144```ts
145optional onChangeAsync: TOnChangeAsync;
146```
147​
148Defined in: [packages/form-core/src/FieldApi.ts:324](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L324)
149​
150An optional property similar to `onChange` but async validation
151​
152#### Example
153​
154```ts
155z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
156```
157​
158***
159​
160### onChangeAsyncDebounceMs?
161​
162```ts
163optional onChangeAsyncDebounceMs: number;
164```
165​
166Defined in: [packages/form-core/src/FieldApi.ts:330](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L330)
167​
168An optional number to represent how long the `onChangeAsync` should wait before running
169​
170If set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds
171​
172***
173​
174### onChangeListenTo?
175​
176```ts
177optional onChangeListenTo: DeepKeys<TParentData>[];
178```
179​
180Defined in: [packages/form-core/src/FieldApi.ts:334](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L334)
181​
182An optional list of field names that should trigger this field's `onChange` and `onChangeAsync` events when its value changes
183​
184***
185​
186### onDynamic?
187​
188```ts
189optional onDynamic: TOnDynamic;
190```
191​
192Defined in: [packages/form-core/src/FieldApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L370)
193​
194***
195​
196### onDynamicAsync?
197​
198```ts
199optional onDynamicAsync: TOnDynamicAsync;
200```
201​
202Defined in: [packages/form-core/src/FieldApi.ts:371](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L371)
203​
204***
205​
206### onDynamicAsyncDebounceMs?
207​
208```ts
209optional onDynamicAsyncDebounceMs: number;
210```
211​
212Defined in: [packages/form-core/src/FieldApi.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L372)
213​
214***
215​
216### onMount?
217​
218```ts
219optional onMount: TOnMount;
220```
221​
222Defined in: [packages/form-core/src/FieldApi.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L312)
223​
224An optional function, that runs on the mount event of input.
225​
226***
227​
228### onSubmit?
229​
230```ts
231optional onSubmit: TOnSubmit;
232```
233​
234Defined in: [packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L363)
235​
236An optional function, that runs on the submit event of form.
237​
238#### Example
239​
240```ts
241z.string().min(1)
242```
243​
244***
245​
246### onSubmitAsync?
247​
248```ts
249optional onSubmitAsync: TOnSubmitAsync;
250```
251​
252Defined in: [packages/form-core/src/FieldApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L369)
253​
254An optional property similar to `onSubmit` but async validation.
255​
256#### Example
257​
258```ts
259z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' })
260```