Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FormOptions.md

274 lines6.3 KB

1---
2id: FormOptions
3title: FormOptions
4---
5​
6# Interface: FormOptions\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
7​
8Defined in: [packages/form-core/src/FormApi.ts:346](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L346)
9​
10An object representing the options for a form.
11​
12## Extends
13​
14- [`BaseFormOptions`](BaseFormOptions.md)\<`TFormData`, `TSubmitMeta`\>
15​
16## Type Parameters
17​
18### TFormData
19​
20`TFormData`
21​
22### TOnMount
23​
24`TOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
25​
26### TOnChange
27​
28`TOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
29​
30### TOnChangeAsync
31​
32`TOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
33​
34### TOnBlur
35​
36`TOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
37​
38### TOnBlurAsync
39​
40`TOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
41​
42### TOnSubmit
43​
44`TOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
45​
46### TOnSubmitAsync
47​
48`TOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
49​
50### TOnDynamic
51​
52`TOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
53​
54### TOnDynamicAsync
55​
56`TOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
57​
58### TOnServer
59​
60`TOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
61​
62### TSubmitMeta
63​
64`TSubmitMeta` = `never`
65​
66## Properties
67​
68### asyncAlways?
69​
70```ts
71optional asyncAlways: boolean;
72```
73​
74Defined in: [packages/form-core/src/FormApi.ts:385](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L385)
75​
76If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
77​
78***
79​
80### asyncDebounceMs?
81​
82```ts
83optional asyncDebounceMs: number;
84```
85​
86Defined in: [packages/form-core/src/FormApi.ts:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L389)
87​
88Optional time in milliseconds if you want to introduce a delay before firing off an async action.
89​
90***
91​
92### canSubmitWhenInvalid?
93​
94```ts
95optional canSubmitWhenInvalid: boolean;
96```
97​
98Defined in: [packages/form-core/src/FormApi.ts:393](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L393)
99​
100If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.
101​
102***
103​
104### defaultState?
105​
106```ts
107optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
108```
109​
110Defined in: [packages/form-core/src/FormApi.ts:367](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L367)
111​
112The default state for the form.
113​
114***
115​
116### defaultValues?
117​
118```ts
119optional defaultValues: TFormData;
120```
121​
122Defined in: [packages/form-core/src/FormApi.ts:336](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L336)
123​
124Set initial values for your form.
125​
126#### Inherited from
127​
128[`BaseFormOptions`](BaseFormOptions.md).[`defaultValues`](BaseFormOptions.md#defaultvalues)
129​
130***
131​
132### formId?
133​
134```ts
135optional formId: string;
136```
137​
138Defined in: [packages/form-core/src/FormApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L363)
139​
140The form name, used for devtools and identification
141​
142***
143​
144### listeners?
145​
146```ts
147optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
148```
149​
150Defined in: [packages/form-core/src/FormApi.ts:415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L415)
151​
152form level listeners
153​
154***
155​
156### onSubmit()?
157​
158```ts
159optional onSubmit: (props) => any;
160```
161​
162Defined in: [packages/form-core/src/FormApi.ts:433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L433)
163​
164A 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>`
165​
166#### Parameters
167​
168##### props
169​
170###### formApi
171​
172[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
173​
174###### meta
175​
176`TSubmitMeta`
177​
178###### value
179​
180`TFormData`
181​
182#### Returns
183​
184`any`
185​
186***
187​
188### onSubmitInvalid()?
189​
190```ts
191optional onSubmitInvalid: (props) => void;
192```
193​
194Defined in: [packages/form-core/src/FormApi.ts:454](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L454)
195​
196Specify an action for scenarios where the user tries to submit an invalid form.
197​
198#### Parameters
199​
200##### props
201​
202###### formApi
203​
204[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
205​
206###### meta
207​
208`TSubmitMeta`
209​
210###### value
211​
212`TFormData`
213​
214#### Returns
215​
216`void`
217​
218***
219​
220### onSubmitMeta?
221​
222```ts
223optional onSubmitMeta: TSubmitMeta;
224```
225​
226Defined in: [packages/form-core/src/FormApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L340)
227​
228onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
229​
230#### Inherited from
231​
232[`BaseFormOptions`](BaseFormOptions.md).[`onSubmitMeta`](BaseFormOptions.md#onsubmitmeta)
233​
234***
235​
236### transform()?
237​
238```ts
239optional transform: (data) => unknown;
240```
241​
242Defined in: [packages/form-core/src/FormApi.ts:478](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L478)
243​
244#### Parameters
245​
246##### data
247​
248`unknown`
249​
250#### Returns
251​
252`unknown`
253​
254***
255​
256### validationLogic?
257​
258```ts
259optional validationLogic: ValidationLogicFn;
260```
261​
262Defined in: [packages/form-core/src/FormApi.ts:410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L410)
263​
264***
265​
266### validators?
267​
268```ts
269optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
270```
271​
272Defined in: [packages/form-core/src/FormApi.ts:397](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L397)
273​
274A list of validators to pass to the form