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

tanstack-form-group.ts

348 lines8.3 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 { FormApi, FormGroupApi, FormGroupApiOptions } from '@tanstack/form-core'
15import { injectStore } from '@tanstack/angular-store'
16import type {
17 DeepKeys,
18 DeepValue,
19 FieldLikeMeta,
20 FormAsyncValidateOrFn,
21 FormGroupAsyncValidateOrFn,
22 FormGroupListeners,
23 FormGroupState,
24 FormGroupValidateOrFn,
25 FormGroupValidators,
26 FormValidateOrFn,
27} from '@tanstack/form-core'
28​
29@Directive({
30 selector: '[tanstackFormGroup]',
31 standalone: true,
32 exportAs: 'formGroup',
33})
34export class TanStackFormGroup<
35 TParentData,
36 const TName extends DeepKeys<TParentData>,
37 TData extends DeepValue<TParentData, TName>,
38 TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
39 TOnChange extends
40 | undefined
41 | FormGroupValidateOrFn<TParentData, TName, TData>,
42 TOnChangeAsync extends
43 | undefined
44 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
45 TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
46 TOnBlurAsync extends
47 | undefined
48 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
49 TOnSubmit extends
50 | undefined
51 | FormGroupValidateOrFn<TParentData, TName, TData>,
52 TOnSubmitAsync extends
53 | undefined
54 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
55 TOnDynamic extends
56 | undefined
57 | FormGroupValidateOrFn<TParentData, TName, TData>,
58 TOnDynamicAsync extends
59 | undefined
60 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
61 TSubmitMeta,
62 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
63 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
64 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
65 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
66 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
67 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
68 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
69 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
70 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
71 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
72 TParentSubmitMeta,
73> implements OnInit {
74 name = input.required<TName>()
75 defaultValue = input<NoInfer<TData>>()
76 asyncDebounceMs = input(undefined as never as number, {
77 transform: numberAttribute,
78 })
79 asyncAlways = input(undefined as never as boolean, {
80 transform: booleanAttribute,
81 })
82 canSubmitWhenInvalid = input(undefined as never as boolean, {
83 transform: booleanAttribute,
84 })
85 tanstackFormGroup =
86 input.required<
87 FormApi<
88 TParentData,
89 TFormOnMount,
90 TFormOnChange,
91 TFormOnChangeAsync,
92 TFormOnBlur,
93 TFormOnBlurAsync,
94 TFormOnSubmit,
95 TFormOnSubmitAsync,
96 TFormOnDynamic,
97 TFormOnDynamicAsync,
98 TFormOnServer,
99 TParentSubmitMeta
100 >
101 >()
102​
103 validators =
104 input<
105 NoInfer<
106 FormGroupValidators<
107 TParentData,
108 TName,
109 TData,
110 TOnMount,
111 TOnChange,
112 TOnChangeAsync,
113 TOnBlur,
114 TOnBlurAsync,
115 TOnSubmit,
116 TOnSubmitAsync,
117 TOnDynamic,
118 TOnDynamicAsync
119 >
120 >
121 >()
122​
123 listeners = input<NoInfer<FormGroupListeners<TParentData, TName, TData>>>()
124​
125 defaultMeta =
126 input<
127 Partial<
128 FieldLikeMeta<
129 TParentData,
130 TName,
131 TData,
132 TOnMount,
133 TOnChange,
134 TOnChangeAsync,
135 TOnBlur,
136 TOnBlurAsync,
137 TOnSubmit,
138 TOnSubmitAsync,
139 TOnDynamic,
140 TOnDynamicAsync,
141 TFormOnMount,
142 TFormOnChange,
143 TFormOnChangeAsync,
144 TFormOnBlur,
145 TFormOnBlurAsync,
146 TFormOnSubmit,
147 TFormOnSubmitAsync,
148 TFormOnDynamic,
149 TFormOnDynamicAsync
150 >
151 >
152 >()
153​
154 defaultState = input<Partial<FormGroupState>>()
155​
156 onSubmitMeta = input<NoInfer<TSubmitMeta>>()
157​
158 onGroupSubmit =
159 input<
160 NoInfer<
161 FormGroupApiOptions<
162 TParentData,
163 TName,
164 TData,
165 TOnMount,
166 TOnChange,
167 TOnChangeAsync,
168 TOnBlur,
169 TOnBlurAsync,
170 TOnSubmit,
171 TOnSubmitAsync,
172 TOnDynamic,
173 TOnDynamicAsync,
174 TSubmitMeta,
175 TFormOnMount,
176 TFormOnChange,
177 TFormOnChangeAsync,
178 TFormOnBlur,
179 TFormOnBlurAsync,
180 TFormOnSubmit,
181 TFormOnSubmitAsync,
182 TFormOnDynamic,
183 TFormOnDynamicAsync,
184 TFormOnServer,
185 TParentSubmitMeta
186 >['onGroupSubmit']
187 >
188 >()
189​
190 onGroupSubmitInvalid =
191 input<
192 NoInfer<
193 FormGroupApiOptions<
194 TParentData,
195 TName,
196 TData,
197 TOnMount,
198 TOnChange,
199 TOnChangeAsync,
200 TOnBlur,
201 TOnBlurAsync,
202 TOnSubmit,
203 TOnSubmitAsync,
204 TOnDynamic,
205 TOnDynamicAsync,
206 TSubmitMeta,
207 TFormOnMount,
208 TFormOnChange,
209 TFormOnChangeAsync,
210 TFormOnBlur,
211 TFormOnBlurAsync,
212 TFormOnSubmit,
213 TFormOnSubmitAsync,
214 TFormOnDynamic,
215 TFormOnDynamicAsync,
216 TFormOnServer,
217 TParentSubmitMeta
218 >['onGroupSubmitInvalid']
219 >
220 >()
221​
222 mode = input<'value' | 'array'>()
223​
224 _api = computed(() => {
225 return new FormGroupApi(untracked(this.options))
226 })
227​
228 get api(): FormGroupApi<
229 TParentData,
230 TName,
231 TData,
232 TOnMount,
233 TOnChange,
234 TOnChangeAsync,
235 TOnBlur,
236 TOnBlurAsync,
237 TOnSubmit,
238 TOnSubmitAsync,
239 TOnDynamic,
240 TOnDynamicAsync,
241 TSubmitMeta,
242 TFormOnMount,
243 TFormOnChange,
244 TFormOnChangeAsync,
245 TFormOnBlur,
246 TFormOnBlurAsync,
247 TFormOnSubmit,
248 TFormOnSubmitAsync,
249 TFormOnDynamic,
250 TFormOnDynamicAsync,
251 TFormOnServer,
252 TParentSubmitMeta
253 > {
254 return this._api()
255 }
256​
257 options = computed(
258 () =>
259 ({
260 defaultValue: this.defaultValue(),
261 asyncDebounceMs: this.asyncDebounceMs(),
262 asyncAlways: this.asyncAlways(),
263 canSubmitWhenInvalid: this.canSubmitWhenInvalid(),
264 validators: this.validators(),
265 listeners: this.listeners(),
266 defaultMeta: this.defaultMeta(),
267 defaultState: this.defaultState(),
268 onSubmitMeta: this.onSubmitMeta(),
269 onGroupSubmit: this.onGroupSubmit(),
270 onGroupSubmitInvalid: this.onGroupSubmitInvalid(),
271 name: this.name(),
272 form: this.tanstackFormGroup(),
273 }) as FormGroupApiOptions<
274 TParentData,
275 TName,
276 TData,
277 TOnMount,
278 TOnChange,
279 TOnChangeAsync,
280 TOnBlur,
281 TOnBlurAsync,
282 TOnSubmit,
283 TOnSubmitAsync,
284 TOnDynamic,
285 TOnDynamicAsync,
286 TSubmitMeta,
287 TFormOnMount,
288 TFormOnChange,
289 TFormOnChangeAsync,
290 TFormOnBlur,
291 TFormOnBlurAsync,
292 TFormOnSubmit,
293 TFormOnSubmitAsync,
294 TFormOnDynamic,
295 TFormOnDynamicAsync,
296 TFormOnServer,
297 TParentSubmitMeta
298 >,
299 )
300​
301 injector = inject(Injector)
302​
303 constructor() {
304 effect((onCleanup) => {
305 const unmount = this._api().mount()
306​
307 onCleanup(() => {
308 unmount()
309 })
310 })
311​
312 effect(() => {
313 this._api().update(this.options())
314 })
315 }
316​
317 cd = inject(ChangeDetectorRef)
318​
319 ngOnInit() {
320 const vals = injectStore(
321 this._api().store,
322 this.mode() === 'array'
323 ? (state) => {
324 return [
325 state.meta,
326 Object.keys((state.value as unknown) ?? []).length,
327 ]
328 }
329 : undefined,
330 {
331 injector: this.injector,
332 },
333 )
334​
335 // Submission lifecycle and aggregated validity now live on `state.meta`
336 // (mirroring `FieldApi.state.meta`), so subscribing to the main store
337 // above is sufficient to keep them reactive.
338​
339 effect(
340 () => {
341 // Load bearing change detection check
342 const _values = vals()
343 this.cd.markForCheck()
344 },
345 { injector: this.injector },
346 )
347 }