@@ -7,7 +7,7 @@ title: FormOptions
7
7
8
8
# Interface: FormOptions\< TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta\>
9
9
10
- Defined in: [ packages/form-core/src/FormApi.ts:321 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L321 )
10
+ Defined in: [ packages/form-core/src/FormApi.ts:322 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L322 )
11
11
12
12
An object representing the options for a form.
13
13
@@ -41,7 +41,7 @@ An object representing the options for a form.
41
41
optional asyncAlways : boolean ;
42
42
```
43
43
44
- Defined in: [ packages/form-core/src/FormApi.ts:356 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L356 )
44
+ Defined in: [ packages/form-core/src/FormApi.ts:357 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L357 )
45
45
46
46
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
47
47
@@ -53,7 +53,7 @@ If true, always run async validation, even when sync validation has produced an
53
53
optional asyncDebounceMs : number ;
54
54
```
55
55
56
- Defined in: [ packages/form-core/src/FormApi.ts:360 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360 )
56
+ Defined in: [ packages/form-core/src/FormApi.ts:361 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L361 )
57
57
58
58
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
59
59
@@ -65,7 +65,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
65
65
optional canSubmitWhenInvalid : boolean ;
66
66
```
67
67
68
- Defined in: [ packages/form-core/src/FormApi.ts:364 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L364 )
68
+ Defined in: [ packages/form-core/src/FormApi.ts:365 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365 )
69
69
70
70
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.
71
71
@@ -77,7 +77,7 @@ If true, allows the form to be submitted in an invalid state i.e. canSubmit will
77
77
optional defaultState : Partial < FormState < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnServer >> ;
78
78
```
79
79
80
- Defined in: [ packages/form-core/src/FormApi.ts:340 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L340 )
80
+ Defined in: [ packages/form-core/src/FormApi.ts:341 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L341 )
81
81
82
82
The default state for the form.
83
83
@@ -89,7 +89,7 @@ The default state for the form.
89
89
optional defaultValues : TFormData ;
90
90
```
91
91
92
- Defined in: [ packages/form-core/src/FormApi.ts:336 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L336 )
92
+ Defined in: [ packages/form-core/src/FormApi.ts:337 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L337 )
93
93
94
94
Set initial values for your form.
95
95
@@ -101,7 +101,7 @@ Set initial values for your form.
101
101
optional listeners : FormListeners < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnServer , TSubmitMeta > ;
102
102
```
103
103
104
- Defined in: [ packages/form-core/src/FormApi.ts:387 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L387 )
104
+ Defined in: [ packages/form-core/src/FormApi.ts:388 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L388 )
105
105
106
106
form level listeners
107
107
@@ -113,7 +113,7 @@ form level listeners
113
113
optional onSubmit : (props ) => any ;
114
114
```
115
115
116
- Defined in: [ packages/form-core/src/FormApi.ts:403 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L403 )
116
+ Defined in: [ packages/form-core/src/FormApi.ts:404 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404 )
117
117
118
118
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> `
119
119
@@ -145,7 +145,7 @@ A function to be called when the form is submitted, what should happen once the
145
145
optional onSubmitInvalid : (props ) => void ;
146
146
```
147
147
148
- Defined in: [ packages/form-core/src/FormApi.ts:422 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L422 )
148
+ Defined in: [ packages/form-core/src/FormApi.ts:423 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L423 )
149
149
150
150
Specify an action for scenarios where the user tries to submit an invalid form.
151
151
@@ -173,7 +173,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
173
173
optional onSubmitMeta : TSubmitMeta ;
174
174
```
175
175
176
- Defined in: [ packages/form-core/src/FormApi.ts:382 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382 )
176
+ Defined in: [ packages/form-core/src/FormApi.ts:383 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L383 )
177
177
178
178
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
179
179
@@ -185,7 +185,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
185
185
optional transform : FormTransform < NoInfer < TFormData > , NoInfer < TOnMount > , NoInfer < TOnChange > , NoInfer < TOnChangeAsync > , NoInfer < TOnBlur > , NoInfer < TOnBlurAsync > , NoInfer < TOnSubmit > , NoInfer < TOnSubmitAsync > , NoInfer < TOnServer > , NoInfer < TSubmitMeta >> ;
186
186
```
187
187
188
- Defined in: [ packages/form-core/src/FormApi.ts:437 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L437 )
188
+ Defined in: [ packages/form-core/src/FormApi.ts:438 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438 )
189
189
190
190
***
191
191
@@ -195,6 +195,6 @@ Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/TanStack/
195
195
optional validators : FormValidators < TFormData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync > ;
196
196
```
197
197
198
- Defined in: [ packages/form-core/src/FormApi.ts:368 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368 )
198
+ Defined in: [ packages/form-core/src/FormApi.ts:369 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369 )
199
199
200
200
A list of validators to pass to the form
0 commit comments