@@ -7,7 +7,7 @@ title: FormOptions
7
7
8
8
# Interface: FormOptions\< TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
9
9
10
- Defined in: [ packages/form-core/src/FormApi.ts:365 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365 )
10
+ Defined in: [ packages/form-core/src/FormApi.ts:369 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369 )
11
11
12
12
An object representing the options for a form.
13
13
@@ -49,7 +49,7 @@ An object representing the options for a form.
49
49
optional asyncAlways : boolean ;
50
50
```
51
51
52
- Defined in: [ packages/form-core/src/FormApi.ts:404 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404 )
52
+ Defined in: [ packages/form-core/src/FormApi.ts:408 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408 )
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
optional asyncDebounceMs : number ;
62
62
```
63
63
64
- Defined in: [ packages/form-core/src/FormApi.ts:408 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408 )
64
+ Defined in: [ packages/form-core/src/FormApi.ts:412 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412 )
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
optional canSubmitWhenInvalid : boolean ;
74
74
```
75
75
76
- Defined in: [ packages/form-core/src/FormApi.ts:412 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412 )
76
+ Defined in: [ packages/form-core/src/FormApi.ts:416 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L416 )
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
85
85
optional defaultState : Partial < FormState < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TOnServer >> ;
86
86
```
87
87
88
- Defined in: [ packages/form-core/src/FormApi.ts:386 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L386 )
88
+ Defined in: [ packages/form-core/src/FormApi.ts:390 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L390 )
89
89
90
90
The default state for the form.
91
91
@@ -97,7 +97,7 @@ The default state for the form.
97
97
optional defaultValues : TFormData ;
98
98
```
99
99
100
- Defined in: [ packages/form-core/src/FormApi.ts:355 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355 )
100
+ Defined in: [ packages/form-core/src/FormApi.ts:359 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359 )
101
101
102
102
Set initial values for your form.
103
103
@@ -113,7 +113,7 @@ Set initial values for your form.
113
113
optional formId : string ;
114
114
```
115
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 )
116
+ Defined in: [ packages/form-core/src/FormApi.ts:386 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L386 )
117
117
118
118
The form name, used for devtools and identification
119
119
@@ -125,7 +125,7 @@ The form name, used for devtools and identification
125
125
optional listeners : FormListeners < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TOnServer , TSubmitMeta > ;
126
126
```
127
127
128
- Defined in: [ packages/form-core/src/FormApi.ts:434 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L434 )
128
+ Defined in: [ packages/form-core/src/FormApi.ts:438 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438 )
129
129
130
130
form level listeners
131
131
@@ -137,7 +137,7 @@ form level listeners
137
137
optional onSubmit : (props ) => any ;
138
138
```
139
139
140
- Defined in: [ packages/form-core/src/FormApi.ts:452 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L452 )
140
+ Defined in: [ packages/form-core/src/FormApi.ts:456 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L456 )
141
141
142
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> `
143
143
@@ -169,7 +169,7 @@ A function to be called when the form is submitted, what should happen once the
169
169
optional onSubmitInvalid : (props ) => void ;
170
170
```
171
171
172
- Defined in: [ packages/form-core/src/FormApi.ts:473 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L473 )
172
+ Defined in: [ packages/form-core/src/FormApi.ts:477 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L477 )
173
173
174
174
Specify an action for scenarios where the user tries to submit an invalid form.
175
175
@@ -201,7 +201,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
201
201
optional onSubmitMeta : TSubmitMeta ;
202
202
```
203
203
204
- Defined in: [ packages/form-core/src/FormApi.ts:359 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359 )
204
+ Defined in: [ packages/form-core/src/FormApi.ts:363 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L363 )
205
205
206
206
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
207
207
@@ -217,7 +217,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
217
217
optional transform : FormTransform < NoInfer < TFormData > , NoInfer < TOnMount > , NoInfer < TOnChange > , NoInfer < TOnChangeAsync > , NoInfer < TOnBlur > , NoInfer < TOnBlurAsync > , NoInfer < TOnSubmit > , NoInfer < TOnSubmitAsync > , NoInfer < TOnDynamic > , NoInfer < TOnDynamicAsync > , NoInfer < TOnServer > , NoInfer < TSubmitMeta >> ;
218
218
```
219
219
220
- Defined in: [ packages/form-core/src/FormApi.ts:491 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L491 )
220
+ Defined in: [ packages/form-core/src/FormApi.ts:495 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L495 )
221
221
222
222
***
223
223
@@ -227,7 +227,7 @@ Defined in: [packages/form-core/src/FormApi.ts:491](https://github.com/TanStack/
227
227
optional validationLogic : ValidationLogicFn ;
228
228
```
229
229
230
- Defined in: [ packages/form-core/src/FormApi.ts:429 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L429 )
230
+ Defined in: [ packages/form-core/src/FormApi.ts:433 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L433 )
231
231
232
232
***
233
233
@@ -237,6 +237,6 @@ Defined in: [packages/form-core/src/FormApi.ts:429](https://github.com/TanStack/
237
237
optional validators : FormValidators < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync > ;
238
238
```
239
239
240
- Defined in: [ packages/form-core/src/FormApi.ts:416 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L416 )
240
+ Defined in: [ packages/form-core/src/FormApi.ts:420 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L420 )
241
241
242
242
A list of validators to pass to the form
0 commit comments