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

FormOptions.md

162 lines3.5 KB

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)