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

FormGroupOptions.md

118 lines2.5 KB

1---
2id: FormGroupOptions
3title: FormGroupOptions
4---
5​
6Defined in: [FormGroupApi/FormGroupApi.public.ts:118](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L118)
7​
8## Type Parameters
9​
10### TFormData
11​
12`TFormData`
13​
14### TGroupName
15​
16`TGroupName`
17​
18### TGroupValue
19​
20`TGroupValue`
21​
22### TGroupValidators
23​
24`TGroupValidators` *extends* [`FormGroupValidators`](../type-aliases/FormGroupValidators.md)\<`TGroupValue`\>
25​
26### TFormErrorTypes
27​
28`TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
29​
30## Properties
31​
32### form
33​
34```ts
35form: FormApi<TFormData, TFormErrorTypes>;
36```
37​
38Defined in: [FormGroupApi/FormGroupApi.public.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L125)
39​
40***
41​
42### name
43​
44```ts
45name: TGroupName;
46```
47​
48Defined in: [FormGroupApi/FormGroupApi.public.ts:126](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L126)
49​
50***
51​
52### onSubmit?
53​
54```ts
55optional onSubmit?: FormGroupSubmitFn<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormErrorTypes>;
56```
57​
58Defined in: [FormGroupApi/FormGroupApi.public.ts:142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L142)
59​
60Called after group submission validation succeeds. The callback is awaited
61before submission finishes.
62​
63#### Example
64​
65```ts
67 // ...
68 onSubmit: () => {
69 setStep(step => step + 1)
70 },
72```
73​
74***
75​
76### onSubmitInvalid?
77​
78```ts
79optional onSubmitInvalid?: (context) => void | Promise<void>;
80```
81​
82Defined in: [FormGroupApi/FormGroupApi.public.ts:165](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L165)
83​
84Called when group validation fails or validation or submission throws. The
85callback is awaited before submission finishes.
86​
87#### Parameters
88​
89##### context
90​
91[`FormGroupSubmitInvalidContext`](FormGroupSubmitInvalidContext.md)\<`TFormData`, `TGroupName`, `TGroupValue`, [`ToFormGroupErrorTypes`](../type-aliases/ToFormGroupErrorTypes.md)\<`NoInfer`\<`TGroupValidators`\>\>, `TFormErrorTypes`\>
92​
93#### Returns
94​
95`void` \| `Promise`\<`void`\>
96​
97#### Example
98​
99```ts
101 // ...
102 onSubmitInvalid: ({ groupApi }) => {
103 document
104 .querySelector<HTMLElement>('[aria-invalid="true"]')
105 ?.focus()
106 },
108```
109​
110***
111​
112### validators?
113​
114```ts
115optional validators?: TGroupValidators;
116```
117​
118Defined in: [FormGroupApi/FormGroupApi.public.ts:127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L127)