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

FieldMeta.md

182 lines3.6 KB

1---
2id: FieldMeta
3title: FieldMeta
4---
5​
6Defined in: [FieldApi/FieldApi.public.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L38)
7​
8## Extends
9​
10- [`BaseFieldMeta`](BaseFieldMeta.md)
11​
12## Type Parameters
13​
14### TFieldError
15​
16`TFieldError`
17​
18## Properties
19​
20### errors
21​
22```ts
23errors: FieldErrors<TFieldError>;
24```
25​
26Defined in: [FieldApi/FieldApi.public.ts:48](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L48)
27​
28***
29​
30### isBlurred
31​
32```ts
33isBlurred: boolean;
34```
35​
36Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L17)
37​
38#### Inherited from
39​
40[`BaseFieldMeta`](BaseFieldMeta.md).[`isBlurred`](BaseFieldMeta.md#isblurred)
41​
42***
43​
44### isDefaultValue
45​
46```ts
47isDefaultValue: boolean;
48```
49​
50Defined in: [FieldApi/FieldApi.public.ts:40](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L40)
51​
52***
53​
54### isDirty
55​
56```ts
57isDirty: boolean;
58```
59​
60Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L16)
61​
62#### Inherited from
63​
64[`BaseFieldMeta`](BaseFieldMeta.md).[`isDirty`](BaseFieldMeta.md#isdirty)
65​
66***
67​
68### isInvalid
69​
70```ts
71isInvalid: boolean;
72```
73​
74Defined in: [FieldApi/FieldApi.public.ts:43](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L43)
75​
76***
77​
78### isPristine
79​
80```ts
81isPristine: boolean;
82```
83​
84Defined in: [FieldApi/FieldApi.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L39)
85​
86***
87​
88### isSelfDirty
89​
90```ts
91isSelfDirty: boolean;
92```
93​
94Defined in: [FieldApi/FieldApi.public.ts:42](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L42)
95​
96***
97​
98### isSelfTouched
99​
100```ts
101isSelfTouched: boolean;
102```
103​
104Defined in: [FieldApi/FieldApi.public.ts:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L41)
105​
106***
107​
108### isSelfValid
109​
110```ts
111isSelfValid: boolean;
112```
113​
114Defined in: [FieldApi/FieldApi.public.ts:44](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L44)
115​
116***
117​
118### isSelfValidating
119​
120```ts
121isSelfValidating: boolean;
122```
123​
124Defined in: [FieldApi/FieldApi.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L45)
125​
126***
127​
128### isTouched
129​
130```ts
131isTouched: boolean;
132```
133​
134Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L15)
135​
136#### Inherited from
137​
138[`BaseFieldMeta`](BaseFieldMeta.md).[`isTouched`](BaseFieldMeta.md#istouched)
139​
140***
141​
142### isValid
143​
144```ts
145isValid: boolean;
146```
147​
148Defined in: [FieldApi/FieldApi.public.ts:46](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L46)
149​
150***
151​
152### isValidating
153​
154```ts
155isValidating: boolean;
156```
157​
158Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L18)
159​
160#### Inherited from
161​
162[`BaseFieldMeta`](BaseFieldMeta.md).[`isValidating`](BaseFieldMeta.md#isvalidating)
163​
164***
165​
166### original
167​
168```ts
169original: OriginalFieldMeta<TFieldError>;
170```
171​
172Defined in: [FieldApi/FieldApi.public.ts:49](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L49)
173​
174***
175​
176### subfields
177​
178```ts
179subfields: SubfieldsMeta;
180```
181​
182Defined in: [FieldApi/FieldApi.public.ts:47](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L47)