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

FormGroupState.md

146 lines3.1 KB

1---
2id: FormGroupState
3title: FormGroupState
4---
5​
6Defined in: [FormGroupApi/FormGroupApi.public.ts:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L176)
7​
8## Type Parameters
9​
10### TGroupValue
11​
12`TGroupValue`
13​
14### TGroupErrorTypes
15​
16`TGroupErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
17​
18## Properties
19​
20### canSubmit
21​
22```ts
23canSubmit: boolean;
24```
25​
26Defined in: [FormGroupApi/FormGroupApi.public.ts:188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L188)
27​
28***
29​
30### errors
31​
32```ts
33errors: FormErrors<TGroupErrorTypes>;
34```
35​
36Defined in: [FormGroupApi/FormGroupApi.public.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L182)
37​
38***
39​
40### isDirty
41​
42```ts
43isDirty: boolean;
44```
45​
46Defined in: [FormGroupApi/FormGroupApi.public.ts:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L184)
47​
48***
49​
50### isInvalid
51​
52```ts
53isInvalid: boolean;
54```
55​
56Defined in: [FormGroupApi/FormGroupApi.public.ts:187](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L187)
57​
58***
59​
60### isPristine
61​
62```ts
63isPristine: boolean;
64```
65​
66Defined in: [FormGroupApi/FormGroupApi.public.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L185)
67​
68***
69​
70### isSubmitSuccessful
71​
72```ts
73isSubmitSuccessful: boolean;
74```
75​
76Defined in: [FormGroupApi/FormGroupApi.public.ts:190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L190)
77​
78***
79​
80### isSubmitting
81​
82```ts
83isSubmitting: boolean;
84```
85​
86Defined in: [FormGroupApi/FormGroupApi.public.ts:189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L189)
87​
88***
89​
90### isTouched
91​
92```ts
93isTouched: boolean;
94```
95​
96Defined in: [FormGroupApi/FormGroupApi.public.ts:183](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L183)
97​
98***
99​
100### isValid
101​
102```ts
103isValid: boolean;
104```
105​
106Defined in: [FormGroupApi/FormGroupApi.public.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L186)
107​
108***
109​
110### isValidating
111​
112```ts
113isValidating: boolean;
114```
115​
116Defined in: [FormGroupApi/FormGroupApi.public.ts:191](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L191)
117​
118***
119​
120### meta
121​
122```ts
123meta: unknown;
124```
125​
126Defined in: [FormGroupApi/FormGroupApi.public.ts:181](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L181)
127​
128***
129​
130### submissionAttempts
131​
132```ts
133submissionAttempts: number;
134```
135​
136Defined in: [FormGroupApi/FormGroupApi.public.ts:192](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L192)
137​
138***
139​
140### values
141​
142```ts
143values: TGroupValue;
144```
145​
146Defined in: [FormGroupApi/FormGroupApi.public.ts:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L180)