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

FormValidators.md

134 lines3.5 KB

1---
2id: FormValidators
3title: FormValidators
4---
5​
6# Interface: FormValidators\<TFormData, TFormValidator\>
7​
8## Type Parameters
9​
10β€’ **TFormData**
11​
12β€’ **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined`
13​
14## Properties
15​
16### onBlur?
17​
18```ts
19optional onBlur: FormValidateOrFn<TFormData, TFormValidator>;
20```
21​
22Optional function that validates the form data when a field loses focus, returns a ValidationError
23​
24#### Defined in
25​
26[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L89)
27​
28***
29​
30### onBlurAsync?
31​
32```ts
33optional onBlurAsync: FormAsyncValidateOrFn<TFormData, TFormValidator>;
34```
35​
36Optional onBlur asynchronous validation method for when a field loses focus return a `ValidationError` or a promise of `Promise<ValidationError>`
37​
38#### Defined in
39​
40[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L93)
41​
42***
43​
44### onBlurAsyncDebounceMs?
45​
46```ts
47optional onBlurAsyncDebounceMs: number;
48```
49​
50The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds.
51​
52#### Defined in
53​
54[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L97)
55​
56***
57​
58### onChange?
59​
60```ts
61optional onChange: FormValidateOrFn<TFormData, TFormValidator>;
62```
63​
64Optional function that checks the validity of your data whenever a value changes
65​
66#### Defined in
67​
68[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L77)
69​
70***
71​
72### onChangeAsync?
73​
74```ts
75optional onChangeAsync: FormAsyncValidateOrFn<TFormData, TFormValidator>;
76```
77​
78Optional onChange asynchronous counterpart to onChange. Useful for more complex validation logic that might involve server requests.
79​
80#### Defined in
81​
82[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L81)
83​
84***
85​
86### onChangeAsyncDebounceMs?
87​
88```ts
89optional onChangeAsyncDebounceMs: number;
90```
91​
92The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds.
93​
94#### Defined in
95​
96[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L85)
97​
98***
99​
100### onMount?
101​
102```ts
103optional onMount: FormValidateOrFn<TFormData, TFormValidator>;
104```
105​
106Optional function that fires as soon as the component mounts.
107​
108#### Defined in
109​
110[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L73)
111​
112***
113​
114### onSubmit?
115​
116```ts
117optional onSubmit: FormValidateOrFn<TFormData, TFormValidator>;
118```
119​
120#### Defined in
121​
122[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L98)
123​
124***
125​
126### onSubmitAsync?
127​
128```ts
129optional onSubmitAsync: FormAsyncValidateOrFn<TFormData, TFormValidator>;
130```
131​
132#### Defined in
133​
134[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L99)