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

TanStackAppField.md

189 lines4.7 KB

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