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{
71 name = input.required<TName>()
72 defaultValue = input<NoInfer<TData>>()
73 asyncDebounceMs = input(undefined as never as number, {
74 transform: numberAttribute,
75 })
76 asyncAlways = input(undefined as never as boolean, {
77 transform: booleanAttribute,
78 })
79 tanstackField =
80 input.required<
81 FormApi<
82 TParentData,
83 TFormOnMount,
84 TFormOnChange,
85 TFormOnChangeAsync,
86 TFormOnBlur,
87 TFormOnBlurAsync,
88 TFormOnSubmit,
89 TFormOnSubmitAsync,
90 TFormOnDynamic,
91 TFormOnDynamicAsync,
92 TFormOnServer,
93 TSubmitMeta
94 >
95 >()
96β
97 validators =
98 input<
99 NoInfer<
100 FieldValidators<
101 TParentData,
102 TName,
103 TData,
104 TOnMount,
105 TOnChange,
106 TOnChangeAsync,
107 TOnBlur,
108 TOnBlurAsync,
109 TOnSubmit,
110 TOnSubmitAsync,
111 TOnDynamic,
112 TOnDynamicAsync
113 >
114 >
115 >()
116β
117 listeners = input<NoInfer<FieldListeners<TParentData, TName, TData>>>()
118 defaultMeta =
119 input<
120 Partial<
121 FieldMeta<
122 TParentData,
123 TName,
124 TData,
125 TOnMount,
126 TOnChange,
127 TOnChangeAsync,
128 TOnBlur,
129 TOnBlurAsync,
130 TOnSubmit,
131 TOnSubmitAsync,
132 TOnDynamic,
133 TOnDynamicAsync,
134 TFormOnMount,
135 TFormOnChange,
136 TFormOnChangeAsync,
137 TFormOnBlur,
138 TFormOnBlurAsync,
139 TFormOnSubmit,
140 TFormOnSubmitAsync,
141 TFormOnDynamic,
142 TFormOnDynamicAsync
143 >
144 >
145 >()
146β
147 mode = input<'value' | 'array'>()
148β
149 disableErrorFlat = input<boolean>()
150β
151 _api = computed(() => {
152 return new FieldApi(untracked(this.options))
153 })
154β
155 get api(): FieldApi<
156 TParentData,
157 TName,
158 TData,
159 TOnMount,
160 TOnChange,
161 TOnChangeAsync,
162 TOnBlur,
163 TOnBlurAsync,
164 TOnSubmit,
165 TOnSubmitAsync,
166 TOnDynamic,
167 TOnDynamicAsync,
168 TFormOnMount,
169 TFormOnChange,
170 TFormOnChangeAsync,
171 TFormOnBlur,
172 TFormOnBlurAsync,
173 TFormOnSubmit,
174 TFormOnSubmitAsync,
175 TFormOnDynamic,
176 TFormOnDynamicAsync,
177 TFormOnServer,
178 TSubmitMeta
179 > {
180 return this._api()
181 }
182β
183 options = computed(
184 () =>
185 ({
186 defaultValue: this.defaultValue(),
187 asyncDebounceMs: this.asyncDebounceMs(),
188 asyncAlways: this.asyncAlways(),
189 disableErrorFlat: this.disableErrorFlat(),
190 validators: this.validators(),
191 listeners: this.listeners(),
192 defaultMeta: this.defaultMeta(),
193 name: this.name(),
194 form: this.tanstackField(),
195 }) as FieldApiOptions<
196 TParentData,
197 TName,
198 TData,
199 TOnMount,
200 TOnChange,
201 TOnChangeAsync,
202 TOnBlur,
203 TOnBlurAsync,
204 TOnSubmit,
205 TOnSubmitAsync,
206 TOnDynamic,
207 TOnDynamicAsync,
208 TFormOnMount,
209 TFormOnChange,
210 TFormOnChangeAsync,
211 TFormOnBlur,
212 TFormOnBlurAsync,
213 TFormOnSubmit,
214 TFormOnSubmitAsync,
215 TFormOnDynamic,
216 TFormOnDynamicAsync,
217 TFormOnServer,
218 TSubmitMeta
219 >,
220 )
221β
222 injector = inject(Injector)
223β
224 constructor() {
225 effect((onCleanup) => {
226 const unmount = this._api().mount()
227β
228 onCleanup(() => {
229 unmount()
230 })
231 })
232β
233 effect(() => {
234 this._api().update(this.options())
235 })
236 }
237β
238 cd = inject(ChangeDetectorRef)
239β
240 ngOnInit() {
241 const vals = injectStore(
242 this._api().store,
243 this.mode() === 'array'
244 ? (state) => {
245 return [
246 state.meta,
247 Object.keys((state.value as unknown) ?? []).length,
248 ]
249 }
250 : undefined,
251 {
252 injector: this.injector,
253 },
254 )
255β
256 effect(
257 () => {
258 // Load bearing change detection check
259 const _values = vals()
260 this.cd.markForCheck()
261 },
262 { injector: this.injector },
263 )
264 }
265}