@@ -7,7 +7,7 @@ title: FormOptions
77
88# Interface: FormOptions\< TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
99
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 )
1111
1212An object representing the options for a form.
1313
@@ -49,7 +49,7 @@ An object representing the options for a form.
4949optional asyncAlways : boolean ;
5050```
5151
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 )
5353
5454If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
5555
@@ -61,7 +61,7 @@ If true, always run async validation, even when sync validation has produced an
6161optional asyncDebounceMs : number ;
6262```
6363
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 )
6565
6666Optional time in milliseconds if you want to introduce a delay before firing off an async action.
6767
@@ -73,7 +73,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
7373optional canSubmitWhenInvalid : boolean ;
7474```
7575
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 )
7777
7878If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.
7979
@@ -85,7 +85,7 @@ If true, allows the form to be submitted in an invalid state i.e. canSubmit will
8585optional defaultState : Partial < FormState < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TOnServer >> ;
8686```
8787
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 )
8989
9090The default state for the form.
9191
@@ -97,7 +97,7 @@ The default state for the form.
9797optional defaultValues : TFormData ;
9898```
9999
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 )
101101
102102Set initial values for your form.
103103
@@ -113,7 +113,7 @@ Set initial values for your form.
113113optional formId : string ;
114114```
115115
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 )
117117
118118The form name, used for devtools and identification
119119
@@ -125,7 +125,7 @@ The form name, used for devtools and identification
125125optional listeners : FormListeners < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TOnServer , TSubmitMeta > ;
126126```
127127
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 )
129129
130130form level listeners
131131
@@ -137,7 +137,7 @@ form level listeners
137137optional onSubmit : (props ) => any ;
138138```
139139
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 )
141141
142142A 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> `
143143
@@ -169,7 +169,7 @@ A function to be called when the form is submitted, what should happen once the
169169optional onSubmitInvalid : (props ) => void ;
170170```
171171
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 )
173173
174174Specify an action for scenarios where the user tries to submit an invalid form.
175175
@@ -201,7 +201,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
201201optional onSubmitMeta : TSubmitMeta ;
202202```
203203
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 )
205205
206206onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
207207
@@ -217,7 +217,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
217217optional 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 >> ;
218218```
219219
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 )
221221
222222***
223223
@@ -227,7 +227,7 @@ Defined in: [packages/form-core/src/FormApi.ts:491](https://github.com/TanStack/
227227optional validationLogic : ValidationLogicFn ;
228228```
229229
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 )
231231
232232***
233233
@@ -237,6 +237,6 @@ Defined in: [packages/form-core/src/FormApi.ts:429](https://github.com/TanStack/
237237optional validators : FormValidators < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync > ;
238238```
239239
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 )
241241
242242A list of validators to pass to the form
0 commit comments