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

tanstack-field.ts

299 lines7.5 KB

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 FieldLikeMeta,
26 FieldListeners,
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 FieldLikeMeta<
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 // Subscribe to the pieces of field state that should trigger a re-render.
241 // For array mode, we only track the length of the array value to avoid
242 // re-renders when child properties change. Meta is tracked piece by piece
243 // so that consumers re-render when any meta property updates.
244 // See: https://github.com/TanStack/form/issues/1961
245 const injectorOpts = { injector: this.injector }
246 const isArrayMode = this.mode() === 'array'
247 const reactiveValue = injectStore(
248 this._api().store,
249 (state) => (isArrayMode ? state.meta._arrayVersion || 0 : state.value),
250 injectorOpts,
251 )
252 const reactiveIsTouched = injectStore(
253 this._api().store,
254 (state) => state.meta.isTouched,
255 injectorOpts,
256 )
257 const reactiveIsBlurred = injectStore(
258 this._api().store,
259 (state) => state.meta.isBlurred,
260 injectorOpts,
261 )
262 const reactiveIsDirty = injectStore(
263 this._api().store,
264 (state) => state.meta.isDirty,
265 injectorOpts,
266 )
267 const reactiveErrorMap = injectStore(
268 this._api().store,
269 (state) => state.meta.errorMap,
270 injectorOpts,
271 )
272 const reactiveErrorSourceMap = injectStore(
273 this._api().store,
274 (state) => state.meta.errorSourceMap,
275 injectorOpts,
276 )
277 const reactiveIsValidating = injectStore(
278 this._api().store,
279 (state) => state.meta.isValidating,
280 injectorOpts,
281 )
282​
283 effect(
284 () => {
285 // Load bearing change detection check β€” read every reactive source so
286 // the effect runs whenever any of them change.
287 reactiveValue()
288 reactiveIsTouched()
289 reactiveIsBlurred()
290 reactiveIsDirty()
291 reactiveErrorMap()
292 reactiveErrorSourceMap()
293 reactiveIsValidating()
294 this.cd.markForCheck()
295 },
296 { injector: this.injector },
297 )
298 }