Open History to see the last commit
1---
2id: FormOptions
3title: FormOptions
4---
5β
6# Interface: FormOptions\<TFormData, TFormValidator\>
7β
8An object representing the options for a form.
9β
10## Type Parameters
11β
12β’ **TFormData**
13β
14β’ **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined`
15β
16## Properties
17β
18### asyncAlways?
19β
20```ts
21optional asyncAlways: boolean;
22```
23β
24If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
25β
26#### Defined in
27β
28[packages/form-core/src/FormApi.ts:133](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L133)
29β
30***
31β
32### asyncDebounceMs?
33β
34```ts
35optional asyncDebounceMs: number;
36```
37β
38Optional time in milliseconds if you want to introduce a delay before firing off an async action.
39β
40#### Defined in
41β
42[packages/form-core/src/FormApi.ts:137](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L137)
43β
44***
45β
46### defaultState?
47β
48```ts
49optional defaultState: Partial<FormState<TFormData>>;
50```
51β
52The default state for the form.
53β
54#### Defined in
55β
56[packages/form-core/src/FormApi.ts:129](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L129)
57β
58***
59β
60### defaultValues?
61β
62```ts
63optional defaultValues: TFormData;
64```
65β
66Set initial values for your form.
67β
68#### Defined in
69β
70[packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L125)
71β
72***
73β
74### onSubmit()?
75β
76```ts
77optional onSubmit: (props) => any;
78```
79β
80A 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>`
81β
82#### Parameters
83β
84β’ **props**
85β
86β’ **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\>
87β
88β’ **props.value**: `TFormData`
89β
90#### Returns
91β
92`any`
93β
94#### Defined in
95β
96[packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L149)
97β
98***
99β
100### onSubmitInvalid()?
101β
102```ts
103optional onSubmitInvalid: (props) => void;
104```
105β
106Specify an action for scenarios where the user tries to submit an invalid form.
107β
108#### Parameters
109β
110β’ **props**
111β
112β’ **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\>
113β
114β’ **props.value**: `TFormData`
115β
116#### Returns
117β
118`void`
119β
120#### Defined in
121β
122[packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L156)
123β
124***
125β
126### transform?
127β
128```ts
129optional transform: FormTransform<TFormData, TFormValidator>;
130```
131β
132#### Defined in
133β
134[packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L160)
135β
136***
137β
138### validatorAdapter?
139β
140```ts
141optional validatorAdapter: TFormValidator;
142```
143β
144A validator adapter to support usage of extra validation types (IE: Zod, Yup, or Valibot usage)
145β
146#### Defined in
147β
148[packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L141)
149β
150***
151β
152### validators?
153β
154```ts
155optional validators: FormValidators<TFormData, TFormValidator>;
156```
157β
158A list of validators to pass to the form
159β
160#### Defined in
161β
162[packages/form-core/src/FormApi.ts:145](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L145)