Open History to see the last commit
1import {
2 ChangeDetectorRef,
3 Directive,
4 Injector,
5 OnInit,
6 booleanAttribute,
7 computed,
8 effect,
9 inject,
10 input,
11 numberAttribute,
12 untracked,
13} from '@angular/core'
14import {
15 FieldApi,
16 FieldApiOptions,
17 FieldAsyncValidateOrFn,
18 FieldValidateOrFn,
19 FormApi,
20} from '@tanstack/form-core'
21import { injectStore } from '@tanstack/angular-store'
22import type {
23 DeepKeys,
24 DeepValue,
25 FieldListeners,
26 FieldMeta,
27 FieldValidators,
28 FormAsyncValidateOrFn,
29 FormValidateOrFn,
30} from '@tanstack/form-core'
31β
32@Directive({
33 selector: '[tanstackField]',
34 standalone: true,
35 exportAs: 'field',
36})
37export class TanStackField<
38 TParentData,
39 const TName extends DeepKeys<TParentData>,
40 TData extends DeepValue<TParentData, TName>,
41 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
42 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
43 TOnChangeAsync extends
44 | undefined
45 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
46 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
47 TOnBlurAsync extends
48 | undefined
49 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
50 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
51 TOnSubmitAsync extends
52 | undefined
53 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
54 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
55 TOnDynamicAsync extends
56 | undefined
57 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
58 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
59 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
60 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
61 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
62 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
63 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
64 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
65 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
66 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
67 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
68 TSubmitMeta,
69> implements OnInit {
70 name = input.required<TName>()
71 defaultValue = input<NoInfer<TData>>()
72 asyncDebounceMs = input(undefined as never as number, {
73 transform: numberAttribute,
74 })
75 asyncAlways = input(undefined as never as boolean, {
76 transform: booleanAttribute,
77 })
78 tanstackField =
79 input.required<
80 FormApi<
81 TParentData,
82 TFormOnMount,
83 TFormOnChange,
84 TFormOnChangeAsync,
85 TFormOnBlur,
86 TFormOnBlurAsync,
87 TFormOnSubmit,
88 TFormOnSubmitAsync,
89 TFormOnDynamic,
90 TFormOnDynamicAsync,
91 TFormOnServer,
92 TSubmitMeta
93 >
94 >()
95β
96 validators =
97 input<
98 NoInfer<
99 FieldValidators<
100 TParentData,
101 TName,
102 TData,
103 TOnMount,
104 TOnChange,
105 TOnChangeAsync,
106 TOnBlur,
107 TOnBlurAsync,
108 TOnSubmit,
109 TOnSubmitAsync,
110 TOnDynamic,
111 TOnDynamicAsync
112 >
113 >
114 >()
115β
116 listeners = input<NoInfer<FieldListeners<TParentData, TName, TData>>>()
117 defaultMeta =
118 input<
119 Partial<
120 FieldMeta<
121 TParentData,
122 TName,
123 TData,
124 TOnMount,
125 TOnChange,
126 TOnChangeAsync,
127 TOnBlur,
128 TOnBlurAsync,
129 TOnSubmit,
130 TOnSubmitAsync,
131 TOnDynamic,
132 TOnDynamicAsync,
133 TFormOnMount,
134 TFormOnChange,
135 TFormOnChangeAsync,
136 TFormOnBlur,
137 TFormOnBlurAsync,
138 TFormOnSubmit,
139 TFormOnSubmitAsync,
140 TFormOnDynamic,
141 TFormOnDynamicAsync
142 >
143 >
144 >()
145β
146 mode = input<'value' | 'array'>()
147β
148 disableErrorFlat = input<boolean>()
149β
150 _api = computed(() => {
151 return new FieldApi(untracked(this.options))
152 })
153β
154 get api(): FieldApi<
155 TParentData,
156 TName,
157 TData,
158 TOnMount,
159 TOnChange,
160 TOnChangeAsync,
161 TOnBlur,
162 TOnBlurAsync,
163 TOnSubmit,
164 TOnSubmitAsync,
165 TOnDynamic,
166 TOnDynamicAsync,
167 TFormOnMount,
168 TFormOnChange,
169 TFormOnChangeAsync,
170 TFormOnBlur,
171 TFormOnBlurAsync,
172 TFormOnSubmit,
173 TFormOnSubmitAsync,
174 TFormOnDynamic,
175 TFormOnDynamicAsync,
176 TFormOnServer,
177 TSubmitMeta
178 > {
179 return this._api()
180 }
181β
182 options = computed(
183 () =>
184 ({
185 defaultValue: this.defaultValue(),
186 asyncDebounceMs: this.asyncDebounceMs(),
187 asyncAlways: this.asyncAlways(),
188 disableErrorFlat: this.disableErrorFlat(),
189 validators: this.validators(),
190 listeners: this.listeners(),
191 defaultMeta: this.defaultMeta(),
192 name: this.name(),
193 form: this.tanstackField(),
194 }) as FieldApiOptions<
195 TParentData,
196 TName,
197 TData,
198 TOnMount,
199 TOnChange,
200 TOnChangeAsync,
201 TOnBlur,
202 TOnBlurAsync,
203 TOnSubmit,
204 TOnSubmitAsync,
205 TOnDynamic,
206 TOnDynamicAsync,
207 TFormOnMount,
208 TFormOnChange,
209 TFormOnChangeAsync,
210 TFormOnBlur,
211 TFormOnBlurAsync,
212 TFormOnSubmit,
213 TFormOnSubmitAsync,
214 TFormOnDynamic,
215 TFormOnDynamicAsync,
216 TFormOnServer,
217 TSubmitMeta
218 >,
219 )
220β
221 injector = inject(Injector)
222β
223 constructor() {
224 effect((onCleanup) => {
225 const unmount = this._api().mount()
226β
227 onCleanup(() => {
228 unmount()
229 })
230 })
231β
232 effect(() => {
233 this._api().update(this.options())
234 })
235 }
236β
237 cd = inject(ChangeDetectorRef)
238β
239 ngOnInit() {
240 const vals = injectStore(
241 this._api().store,
242 this.mode() === 'array'
243 ? (state) => {
244 return [
245 state.meta,
246 Object.keys((state.value as unknown) ?? []).length,
247 ]
248 }
249 : undefined,
250 {
251 injector: this.injector,
252 },
253 )
254β
255 effect(
256 () => {
257 // Load bearing change detection check
258 const _values = vals()
259 this.cd.markForCheck()
260 },
261 { injector: this.injector },
262 )
263 }
264}