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

BaseFormOptions.md

48 lines1019 Bytes

1---
2id: BaseFormOptions
3title: BaseFormOptions
4---
5​
6# Interface: BaseFormOptions\<TFormData, TSubmitMeta\>
7​
8Defined in: [packages/form-core/src/FormApi.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L332)
9​
10An object representing the base properties of a form, unrelated to any validators
11​
12## Extended by
13​
14- [`FormOptions`](FormOptions.md)
15​
16## Type Parameters
17​
18### TFormData
19​
20`TFormData`
21​
22### TSubmitMeta
23​
24`TSubmitMeta` = `never`
25​
26## Properties
27​
28### defaultValues?
29​
30```ts
31optional defaultValues: TFormData;
32```
33​
34Defined in: [packages/form-core/src/FormApi.ts:336](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L336)
35​
36Set initial values for your form.
37​
38***
39​
40### onSubmitMeta?
41​
42```ts
43optional onSubmitMeta: TSubmitMeta;
44```
45​
46Defined in: [packages/form-core/src/FormApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L340)
47​
48onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props