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
Copy file name to clipboardExpand all lines: docs/reference/interfaces/formoptions.md
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ An object representing the options for a form.
49
49
optionalasyncAlways: boolean;
50
50
```
51
51
52
-
Defined in: [packages/form-core/src/FormApi.ts:400](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L400)
52
+
Defined in: [packages/form-core/src/FormApi.ts:404](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404)
53
53
54
54
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
55
55
@@ -61,7 +61,7 @@ If true, always run async validation, even when sync validation has produced an
61
61
optionalasyncDebounceMs: number;
62
62
```
63
63
64
-
Defined in: [packages/form-core/src/FormApi.ts:404](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404)
64
+
Defined in: [packages/form-core/src/FormApi.ts:408](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408)
65
65
66
66
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
67
67
@@ -73,7 +73,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
73
73
optionalcanSubmitWhenInvalid: boolean;
74
74
```
75
75
76
-
Defined in: [packages/form-core/src/FormApi.ts:408](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408)
76
+
Defined in: [packages/form-core/src/FormApi.ts:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412)
77
77
78
78
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.
79
79
@@ -85,7 +85,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:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382)
88
+
Defined in: [packages/form-core/src/FormApi.ts:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L386)
89
89
90
90
The default state for the form.
91
91
@@ -107,13 +107,25 @@ Set initial values for your form.
107
107
108
108
***
109
109
110
+
### formId?
111
+
112
+
```ts
113
+
optionalformId: string;
114
+
```
115
+
116
+
Defined in: [packages/form-core/src/FormApi.ts:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382)
117
+
118
+
The form name, used for devtools and identification
Defined in: [packages/form-core/src/FormApi.ts:430](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L430)
128
+
Defined in: [packages/form-core/src/FormApi.ts:434](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L434)
117
129
118
130
form level listeners
119
131
@@ -125,7 +137,7 @@ form level listeners
125
137
optionalonSubmit: (props) =>any;
126
138
```
127
139
128
-
Defined in: [packages/form-core/src/FormApi.ts:448](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L448)
140
+
Defined in: [packages/form-core/src/FormApi.ts:452](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L452)
129
141
130
142
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>`
131
143
@@ -157,7 +169,7 @@ A function to be called when the form is submitted, what should happen once the
157
169
optionalonSubmitInvalid: (props) =>void;
158
170
```
159
171
160
-
Defined in: [packages/form-core/src/FormApi.ts:469](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L469)
172
+
Defined in: [packages/form-core/src/FormApi.ts:473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L473)
161
173
162
174
Specify an action for scenarios where the user tries to submit an invalid form.
163
175
@@ -205,7 +217,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
Defined in: [packages/form-core/src/FormApi.ts:487](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L487)
220
+
Defined in: [packages/form-core/src/FormApi.ts:491](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L491)
209
221
210
222
***
211
223
@@ -215,7 +227,7 @@ Defined in: [packages/form-core/src/FormApi.ts:487](https://github.com/TanStack/
215
227
optionalvalidationLogic: ValidationLogicFn;
216
228
```
217
229
218
-
Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L425)
230
+
Defined in: [packages/form-core/src/FormApi.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L429)
219
231
220
232
***
221
233
@@ -225,6 +237,6 @@ Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/
Defined in: [packages/form-core/src/FormApi.ts:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412)
240
+
Defined in: [packages/form-core/src/FormApi.ts:416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L416)
Defined in: [packages/form-core/src/FormApi.ts:711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L711)
10
+
Defined in: [packages/form-core/src/FormApi.ts:715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L715)
11
11
12
12
An object representing the current state of the form.
13
13
@@ -47,7 +47,7 @@ An object representing the current state of the form.
47
47
optional_force_re_eval: boolean;
48
48
```
49
49
50
-
Defined in: [packages/form-core/src/FormApi.ts:630](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L630)
50
+
Defined in: [packages/form-core/src/FormApi.ts:634](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L634)
51
51
52
52
@private, used to force a re-evaluation of the form state when options change
53
53
@@ -65,7 +65,7 @@ BaseFormState._force_re_eval
65
65
canSubmit: boolean;
66
66
```
67
67
68
-
Defined in: [packages/form-core/src/FormApi.ts:704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L704)
68
+
Defined in: [packages/form-core/src/FormApi.ts:708](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L708)
69
69
70
70
A boolean indicating if the form can be submitted based on its current state.
Defined in: [packages/form-core/src/FormApi.ts:574](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L574)
86
+
Defined in: [packages/form-core/src/FormApi.ts:578](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L578)
87
87
88
88
The error map for the form itself.
89
89
@@ -111,7 +111,7 @@ errors: (
111
111
|UnwrapFormAsyncValidateOrFn<TOnServer>)[];
112
112
```
113
113
114
-
Defined in: [packages/form-core/src/FormApi.ts:657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L657)
114
+
Defined in: [packages/form-core/src/FormApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L661)
Defined in: [packages/form-core/src/FormApi.ts:708](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L708)
132
+
Defined in: [packages/form-core/src/FormApi.ts:712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L712)
133
133
134
134
A record of field metadata for each field in the form.
Defined in: [packages/form-core/src/FormApi.ts:593](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L593)
150
+
Defined in: [packages/form-core/src/FormApi.ts:597](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L597)
151
151
152
152
A record of field metadata for each field in the form, not including the derived properties, like `errors` and such
153
153
@@ -165,7 +165,7 @@ BaseFormState.fieldMetaBase
165
165
isBlurred: boolean;
166
166
```
167
167
168
-
Defined in: [packages/form-core/src/FormApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L684)
168
+
Defined in: [packages/form-core/src/FormApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L688)
169
169
170
170
A boolean indicating if any of the form fields have been blurred.
171
171
@@ -183,7 +183,7 @@ DerivedFormState.isBlurred
183
183
isDefaultValue: boolean;
184
184
```
185
185
186
-
Defined in: [packages/form-core/src/FormApi.ts:696](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L696)
186
+
Defined in: [packages/form-core/src/FormApi.ts:700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L700)
187
187
188
188
A boolean indicating if all of the form's fields are the same as default values.
Defined in: [packages/form-core/src/FormApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L688)
204
+
Defined in: [packages/form-core/src/FormApi.ts:692](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L692)
205
205
206
206
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`.
207
207
@@ -219,7 +219,7 @@ DerivedFormState.isDirty
219
219
isFieldsValid: boolean;
220
220
```
221
221
222
-
Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676)
222
+
Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680)
223
223
224
224
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:672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L672)
240
+
Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676)
241
241
242
242
A boolean indicating if any of the form fields are currently validating.
Defined in: [packages/form-core/src/FormApi.ts:653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L653)
258
+
Defined in: [packages/form-core/src/FormApi.ts:657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L657)
259
259
260
260
A boolean indicating if the form is valid.
261
261
@@ -273,7 +273,7 @@ DerivedFormState.isFormValid
273
273
isFormValidating: boolean;
274
274
```
275
275
276
-
Defined in: [packages/form-core/src/FormApi.ts:649](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L649)
276
+
Defined in: [packages/form-core/src/FormApi.ts:653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L653)
277
277
278
278
A boolean indicating if the form is currently validating.
Defined in: [packages/form-core/src/FormApi.ts:692](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L692)
294
+
Defined in: [packages/form-core/src/FormApi.ts:696](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L696)
295
295
296
296
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`.
297
297
@@ -309,7 +309,7 @@ DerivedFormState.isPristine
309
309
isSubmitSuccessful: boolean;
310
310
```
311
311
312
-
Defined in: [packages/form-core/src/FormApi.ts:626](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L626)
312
+
Defined in: [packages/form-core/src/FormApi.ts:630](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L630)
313
313
314
314
A boolean indicating if the last submission was successful.
Defined in: [packages/form-core/src/FormApi.ts:614](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L614)
330
+
Defined in: [packages/form-core/src/FormApi.ts:618](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L618)
331
331
332
332
A boolean indicating if the `onSubmit` function has completed successfully.
333
333
@@ -349,7 +349,7 @@ BaseFormState.isSubmitted
349
349
isSubmitting: boolean;
350
350
```
351
351
352
-
Defined in: [packages/form-core/src/FormApi.ts:606](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L606)
352
+
Defined in: [packages/form-core/src/FormApi.ts:610](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L610)
353
353
354
354
A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called.
355
355
@@ -375,7 +375,7 @@ BaseFormState.isSubmitting
375
375
isTouched: boolean;
376
376
```
377
377
378
-
Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680)
378
+
Defined in: [packages/form-core/src/FormApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L684)
379
379
380
380
A boolean indicating if any of the form fields have been touched.
381
381
@@ -393,7 +393,7 @@ DerivedFormState.isTouched
393
393
isValid: boolean;
394
394
```
395
395
396
-
Defined in: [packages/form-core/src/FormApi.ts:700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L700)
396
+
Defined in: [packages/form-core/src/FormApi.ts:704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L704)
397
397
398
398
A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors.
399
399
@@ -411,7 +411,7 @@ DerivedFormState.isValid
411
411
isValidating: boolean;
412
412
```
413
413
414
-
Defined in: [packages/form-core/src/FormApi.ts:618](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L618)
414
+
Defined in: [packages/form-core/src/FormApi.ts:622](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L622)
415
415
416
416
A boolean indicating if the form or any of its fields are currently validating.
417
417
@@ -429,7 +429,7 @@ BaseFormState.isValidating
429
429
submissionAttempts: number;
430
430
```
431
431
432
-
Defined in: [packages/form-core/src/FormApi.ts:622](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L622)
432
+
Defined in: [packages/form-core/src/FormApi.ts:626](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L626)
433
433
434
434
A counter for tracking the number of submission attempts.
Defined in: [packages/form-core/src/FormApi.ts:589](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L589)
450
+
Defined in: [packages/form-core/src/FormApi.ts:593](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L593)
451
451
452
452
An internal mechanism used for keeping track of validation logic in a form.
Defined in: [packages/form-core/src/FormApi.ts:570](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L570)
468
+
Defined in: [packages/form-core/src/FormApi.ts:574](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L574)
Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830)
14
+
Defined in: [packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L834)
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:750](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L750)
14
+
Defined in: [packages/form-core/src/FormApi.ts:754](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L754)
Defined in: [packages/form-core/src/FormApi.ts:554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L554)
14
+
Defined in: [packages/form-core/src/FormApi.ts:558](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L558)
15
15
16
16
An object representing the current state of the form.
Defined in: [packages/form-core/src/FormApi.ts:633](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L633)
14
+
Defined in: [packages/form-core/src/FormApi.ts:637](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L637)
Copy file name to clipboardExpand all lines: docs/reference/type-aliases/fieldinfo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ title: FieldInfo
11
11
typeFieldInfo<TFormData> =object;
12
12
```
13
13
14
-
Defined in: [packages/form-core/src/FormApi.ts:516](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L516)
14
+
Defined in: [packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L520)
15
15
16
16
An object representing the field information for a specific field within the form.
Copy file name to clipboardExpand all lines: docs/reference/type-aliases/validationmeta.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ title: ValidationMeta
11
11
typeValidationMeta=object;
12
12
```
13
13
14
-
Defined in: [packages/form-core/src/FormApi.ts:506](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L506)
14
+
Defined in: [packages/form-core/src/FormApi.ts:510](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L510)
15
15
16
16
An object representing the validation metadata for a field. Not intended for public usage.
0 commit comments