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

TanStackField.md

212 lines4.4 KB

1---
2id: TanStackField
3title: TanStackField
4---
5​
6Defined in: [tanstack-field.ts:255](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L255)
7​
8## Extends
9​
10- `TanStackFieldBase`\<`TSource`, `TFieldName`, `TFieldValue`, `TFieldValidators`\>
11​
12## Extended by
13​
14- [`TanStackAppField`](TanStackAppField.md)
15​
16## Type Parameters
17​
18### TSource
19​
20`TSource` *extends* [`AngularFieldSource`](../type-aliases/AngularFieldSource.md)
21​
22### TFieldName
23​
24`TFieldName` *extends* `DeepKeys`\<[`AngularFieldData`](../type-aliases/AngularFieldData.md)\<`TSource`\>\>
25​
26### TFieldValue
27​
28`TFieldValue` *extends* `DeepValue`\<[`AngularFieldData`](../type-aliases/AngularFieldData.md)\<`TSource`\>, `TFieldName`\>
29​
30### TFieldValidators
31​
32`TFieldValidators` *extends* `FieldValidators`\<[`AngularFieldData`](../type-aliases/AngularFieldData.md)\<`TSource`\>, `TFieldName`, `TFieldValue`\>
33​
34## Constructors
35​
36### Constructor
37​
38```ts
39new TanStackField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackField<TSource, TFieldName, TFieldValue, TFieldValidators>;
40```
41​
42Defined in: [tanstack-field.ts:201](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L201)
43​
44#### Returns
45​
46`TanStackField`\<`TSource`, `TFieldName`, `TFieldValue`, `TFieldValidators`\>
47​
48#### Inherited from
49​
50```ts
51TanStackFieldBase<
52 TSource,
53 TFieldName,
54 TFieldValue,
55 TFieldValidators
56>.constructor
57```
58​
59## Properties
60​
61### errorBoundary
62​
63```ts
64errorBoundary: InputSignal<boolean | undefined>;
65```
66​
67Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
68​
69#### Inherited from
70​
71```ts
72TanStackFieldBase.errorBoundary
73```
74​
75***
76​
77### errorVisibility
78​
79```ts
80errorVisibility: InputSignal<
81 | ErrorVisibility<AngularParentFormData<TSource>, AngularSourceFormErrorTypes<TSource>>
82| undefined>;
83```
84​
85Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
86​
87#### Inherited from
88​
89```ts
90TanStackFieldBase.errorVisibility
91```
92​
93***
94​
95### isArrayField
96​
97```ts
98protected readonly isArrayField: false = false;
99```
100​
101Defined in: [tanstack-field.ts:271](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L271)
102​
103#### Overrides
104​
105```ts
106TanStackFieldBase.isArrayField
107```
108​
109***
110​
111### listeners
112​
113```ts
114listeners: InputSignal<
115 | NoInfer<FieldListeners<AngularFieldData<TSource>, TFieldName, TFieldValue, FallbackToValidationIssue<
116 | ExtractValidatorFieldError<TFieldValidators, FieldValidators<any, any, any>>
117 | ExtractFormFieldError<AngularSourceFormErrorTypes<TSource>>
118 | unknown extends AngularSourceGroupFieldError<TSource> ? never : AngularSourceGroupFieldError<TSource>>, AngularParentFormData<TSource>, AngularSourceFormErrorTypes<TSource>>>
119| undefined>;
120```
121​
122Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
123​
124#### Inherited from
125​
126```ts
127TanStackFieldBase.listeners
128```
129​
130***
131​
132### name
133​
134```ts
135name: InputSignal<TFieldName>;
136```
137​
138Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
139​
140#### Inherited from
141​
142```ts
143TanStackFieldBase.name
144```
145​
146***
147​
148### tanstackField
149​
150```ts
151tanstackField: InputSignal<TSource>;
152```
153​
154Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L270)
155​
156***
157​
158### validators
159​
160```ts
161validators: InputSignal<NoInfer<TFieldValidators> | undefined>;
162```
163​
164Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
165​
166#### Inherited from
167​
168```ts
169TanStackFieldBase.validators
170```
171​
172## Accessors
173​
174### api
175​
176#### Get Signature
177​
178```ts
179get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;
180```
181​
182Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
183​
184##### Returns
185​
186`AngularSourceFieldApi`\<`TSource`, `TFieldName`, `TFieldValue`, `TFieldValidators`\>
187​
188#### Inherited from
189​
190```ts
191TanStackFieldBase.api
192```
193​
194## Methods
195​
196### getSource()
197​
198```ts
199protected getSource(): TSource;
200```
201​
202Defined in: [tanstack-field.ts:272](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L272)
203​
204#### Returns
205​
206`TSource`
207​
208#### Overrides
209​
210```ts
211TanStackFieldBase.getSource
212```