You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Defined in: [packages/form-core/src/FormApi.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L323)
10
+
Defined in: [packages/form-core/src/FormApi.ts:324](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L324)
11
11
12
12
An object representing the base properties of a form, unrelated to any validators
13
13
@@ -29,7 +29,7 @@ An object representing the base properties of a form, unrelated to any validator
29
29
optionaldefaultValues: TFormData;
30
30
```
31
31
32
-
Defined in: [packages/form-core/src/FormApi.ts:327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L327)
32
+
Defined in: [packages/form-core/src/FormApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L328)
33
33
34
34
Set initial values for your form.
35
35
@@ -41,6 +41,6 @@ Set initial values for your form.
41
41
optionalonSubmitMeta: TSubmitMeta;
42
42
```
43
43
44
-
Defined in: [packages/form-core/src/FormApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L331)
44
+
Defined in: [packages/form-core/src/FormApi.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L332)
45
45
46
46
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
Defined in: [packages/form-core/src/FormApi.ts:337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L337)
10
+
Defined in: [packages/form-core/src/FormApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L338)
11
11
12
12
An object representing the options for a form.
13
13
@@ -45,7 +45,7 @@ An object representing the options for a form.
45
45
optionalasyncAlways: boolean;
46
46
```
47
47
48
-
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
48
+
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
49
49
50
50
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
51
51
@@ -57,7 +57,7 @@ If true, always run async validation, even when sync validation has produced an
57
57
optionalasyncDebounceMs: number;
58
58
```
59
59
60
-
Defined in: [packages/form-core/src/FormApi.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L372)
60
+
Defined in: [packages/form-core/src/FormApi.ts:373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L373)
61
61
62
62
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
63
63
@@ -69,7 +69,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
69
69
optionalcanSubmitWhenInvalid: boolean;
70
70
```
71
71
72
-
Defined in: [packages/form-core/src/FormApi.ts:376](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L376)
72
+
Defined in: [packages/form-core/src/FormApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L377)
73
73
74
74
If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.
75
75
@@ -81,7 +81,7 @@ If true, allows the form to be submitted in an invalid state i.e. canSubmit will
Defined in: [packages/form-core/src/FormApi.ts:352](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L352)
84
+
Defined in: [packages/form-core/src/FormApi.ts:353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L353)
85
85
86
86
The default state for the form.
87
87
@@ -93,7 +93,7 @@ The default state for the form.
93
93
optionaldefaultValues: TFormData;
94
94
```
95
95
96
-
Defined in: [packages/form-core/src/FormApi.ts:327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L327)
96
+
Defined in: [packages/form-core/src/FormApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L328)
97
97
98
98
Set initial values for your form.
99
99
@@ -109,7 +109,7 @@ Set initial values for your form.
Defined in: [packages/form-core/src/FormApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L394)
112
+
Defined in: [packages/form-core/src/FormApi.ts:395](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L395)
113
113
114
114
form level listeners
115
115
@@ -121,7 +121,7 @@ form level listeners
121
121
optionalonSubmit: (props) =>any;
122
122
```
123
123
124
-
Defined in: [packages/form-core/src/FormApi.ts:410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L410)
124
+
Defined in: [packages/form-core/src/FormApi.ts:411](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L411)
125
125
126
126
A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise<any>`
127
127
@@ -153,7 +153,7 @@ A function to be called when the form is submitted, what should happen once the
153
153
optionalonSubmitInvalid: (props) =>void;
154
154
```
155
155
156
-
Defined in: [packages/form-core/src/FormApi.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L429)
156
+
Defined in: [packages/form-core/src/FormApi.ts:430](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L430)
157
157
158
158
Specify an action for scenarios where the user tries to submit an invalid form.
159
159
@@ -165,6 +165,10 @@ Specify an action for scenarios where the user tries to submit an invalid form.
@@ -181,7 +185,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
181
185
optionalonSubmitMeta: TSubmitMeta;
182
186
```
183
187
184
-
Defined in: [packages/form-core/src/FormApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L331)
188
+
Defined in: [packages/form-core/src/FormApi.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L332)
185
189
186
190
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
187
191
@@ -197,7 +201,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
Defined in: [packages/form-core/src/FormApi.ts:444](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L444)
204
+
Defined in: [packages/form-core/src/FormApi.ts:446](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L446)
201
205
202
206
***
203
207
@@ -207,6 +211,6 @@ Defined in: [packages/form-core/src/FormApi.ts:444](https://github.com/TanStack/
Defined in: [packages/form-core/src/FormApi.ts:380](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L380)
214
+
Defined in: [packages/form-core/src/FormApi.ts:381](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L381)
Defined in: [packages/form-core/src/FormApi.ts:654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L654)
10
+
Defined in: [packages/form-core/src/FormApi.ts:656](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L656)
11
11
12
12
An object representing the current state of the form.
13
13
@@ -43,7 +43,7 @@ An object representing the current state of the form.
43
43
optional_force_re_eval: boolean;
44
44
```
45
45
46
-
Defined in: [packages/form-core/src/FormApi.ts:577](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L577)
46
+
Defined in: [packages/form-core/src/FormApi.ts:579](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L579)
47
47
48
48
@private, used to force a re-evaluation of the form state when options change
49
49
@@ -61,7 +61,7 @@ BaseFormState._force_re_eval
61
61
canSubmit: boolean;
62
62
```
63
63
64
-
Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647)
64
+
Defined in: [packages/form-core/src/FormApi.ts:649](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L649)
65
65
66
66
A boolean indicating if the form can be submitted based on its current state.
Defined in: [packages/form-core/src/FormApi.ts:523](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L523)
82
+
Defined in: [packages/form-core/src/FormApi.ts:525](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L525)
83
83
84
84
The error map for the form itself.
85
85
@@ -105,7 +105,7 @@ errors: (
105
105
|UnwrapFormAsyncValidateOrFn<TOnServer>)[];
106
106
```
107
107
108
-
Defined in: [packages/form-core/src/FormApi.ts:602](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L602)
108
+
Defined in: [packages/form-core/src/FormApi.ts:604](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L604)
Defined in: [packages/form-core/src/FormApi.ts:651](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L651)
126
+
Defined in: [packages/form-core/src/FormApi.ts:653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L653)
127
127
128
128
A record of field metadata for each field in the form.
Defined in: [packages/form-core/src/FormApi.ts:540](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L540)
144
+
Defined in: [packages/form-core/src/FormApi.ts:542](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L542)
145
145
146
146
A record of field metadata for each field in the form, not including the derived properties, like `errors` and such
147
147
@@ -159,7 +159,7 @@ BaseFormState.fieldMetaBase
159
159
isBlurred: boolean;
160
160
```
161
161
162
-
Defined in: [packages/form-core/src/FormApi.ts:627](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L627)
162
+
Defined in: [packages/form-core/src/FormApi.ts:629](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L629)
163
163
164
164
A boolean indicating if any of the form fields have been blurred.
165
165
@@ -177,7 +177,7 @@ DerivedFormState.isBlurred
177
177
isDefaultValue: boolean;
178
178
```
179
179
180
-
Defined in: [packages/form-core/src/FormApi.ts:639](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L639)
180
+
Defined in: [packages/form-core/src/FormApi.ts:641](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L641)
181
181
182
182
A boolean indicating if all of the form's fields are the same as default values.
Defined in: [packages/form-core/src/FormApi.ts:631](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L631)
198
+
Defined in: [packages/form-core/src/FormApi.ts:633](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L633)
199
199
200
200
A boolean indicating if any of the form's fields' values have been modified by the user. Evaluates `true` if the user have modified at least one of the fields. Opposite of `isPristine`.
201
201
@@ -213,7 +213,7 @@ DerivedFormState.isDirty
213
213
isFieldsValid: boolean;
214
214
```
215
215
216
-
Defined in: [packages/form-core/src/FormApi.ts:619](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L619)
216
+
Defined in: [packages/form-core/src/FormApi.ts:621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L621)
217
217
218
218
A boolean indicating if all the form fields are valid. Evaluates `true` if there are no field errors.
Defined in: [packages/form-core/src/FormApi.ts:615](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L615)
234
+
Defined in: [packages/form-core/src/FormApi.ts:617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L617)
235
235
236
236
A boolean indicating if any of the form fields are currently validating.
Defined in: [packages/form-core/src/FormApi.ts:598](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L598)
252
+
Defined in: [packages/form-core/src/FormApi.ts:600](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L600)
253
253
254
254
A boolean indicating if the form is valid.
255
255
@@ -267,7 +267,7 @@ DerivedFormState.isFormValid
267
267
isFormValidating: boolean;
268
268
```
269
269
270
-
Defined in: [packages/form-core/src/FormApi.ts:594](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L594)
270
+
Defined in: [packages/form-core/src/FormApi.ts:596](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L596)
271
271
272
272
A boolean indicating if the form is currently validating.
Defined in: [packages/form-core/src/FormApi.ts:635](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L635)
288
+
Defined in: [packages/form-core/src/FormApi.ts:637](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L637)
289
289
290
290
A boolean indicating if none of the form's fields' values have been modified by the user. Evaluates `true` if the user have not modified any of the fields. Opposite of `isDirty`.
291
291
@@ -303,7 +303,7 @@ DerivedFormState.isPristine
303
303
isSubmitSuccessful: boolean;
304
304
```
305
305
306
-
Defined in: [packages/form-core/src/FormApi.ts:573](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L573)
306
+
Defined in: [packages/form-core/src/FormApi.ts:575](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L575)
307
307
308
308
A boolean indicating if the last submission was successful.
Defined in: [packages/form-core/src/FormApi.ts:561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L561)
324
+
Defined in: [packages/form-core/src/FormApi.ts:563](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L563)
325
325
326
326
A boolean indicating if the `onSubmit` function has completed successfully.
327
327
@@ -343,7 +343,7 @@ BaseFormState.isSubmitted
343
343
isSubmitting: boolean;
344
344
```
345
345
346
-
Defined in: [packages/form-core/src/FormApi.ts:553](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L553)
346
+
Defined in: [packages/form-core/src/FormApi.ts:555](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L555)
347
347
348
348
A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called.
349
349
@@ -369,7 +369,7 @@ BaseFormState.isSubmitting
369
369
isTouched: boolean;
370
370
```
371
371
372
-
Defined in: [packages/form-core/src/FormApi.ts:623](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L623)
372
+
Defined in: [packages/form-core/src/FormApi.ts:625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L625)
373
373
374
374
A boolean indicating if any of the form fields have been touched.
375
375
@@ -387,7 +387,7 @@ DerivedFormState.isTouched
387
387
isValid: boolean;
388
388
```
389
389
390
-
Defined in: [packages/form-core/src/FormApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L643)
390
+
Defined in: [packages/form-core/src/FormApi.ts:645](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L645)
391
391
392
392
A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors.
393
393
@@ -405,7 +405,7 @@ DerivedFormState.isValid
405
405
isValidating: boolean;
406
406
```
407
407
408
-
Defined in: [packages/form-core/src/FormApi.ts:565](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L565)
408
+
Defined in: [packages/form-core/src/FormApi.ts:567](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L567)
409
409
410
410
A boolean indicating if the form or any of its fields are currently validating.
411
411
@@ -423,7 +423,7 @@ BaseFormState.isValidating
423
423
submissionAttempts: number;
424
424
```
425
425
426
-
Defined in: [packages/form-core/src/FormApi.ts:569](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L569)
426
+
Defined in: [packages/form-core/src/FormApi.ts:571](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L571)
427
427
428
428
A counter for tracking the number of submission attempts.
Defined in: [packages/form-core/src/FormApi.ts:536](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L536)
444
+
Defined in: [packages/form-core/src/FormApi.ts:538](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L538)
445
445
446
446
An internal mechanism used for keeping track of validation logic in a form.
Defined in: [packages/form-core/src/FormApi.ts:519](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L519)
462
+
Defined in: [packages/form-core/src/FormApi.ts:521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L521)
Defined in: [packages/form-core/src/FormApi.ts:758](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L758)
14
+
Defined in: [packages/form-core/src/FormApi.ts:760](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L760)
15
15
16
16
A type representing the Form API with all generics set to `any` for convenience.
Defined in: [packages/form-core/src/FormApi.ts:687](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L687)
14
+
Defined in: [packages/form-core/src/FormApi.ts:689](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L689)
0 commit comments