Open History to see the last commit
1import { Injectable, inject, signal } from '@angular/core'
2import { FormApi } from '@tanstack/form-core'
3import type {
4 FormAsyncValidateOrFn,
5 FormOptions,
6 FormValidateOrFn,
7} from '@tanstack/form-core'
8β
9@Injectable({ providedIn: null })
10export class TanStackWithFormInjectable {
11 _form = signal<
12 FormApi<any, any, any, any, any, any, any, any, any, any, any, any>
13 >(null as never)
14}
15β
16interface TanStackWithFormRef<
17 TFormData,
18 TOnMount extends undefined | FormValidateOrFn<TFormData>,
19 TOnChange extends undefined | FormValidateOrFn<TFormData>,
20 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
21 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
22 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
23 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
24 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
25 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
26 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
27 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
28 TSubmitMeta,
29> {
30 readonly form: FormApi<
31 TFormData,
32 TOnMount,
33 TOnChange,
34 TOnChangeAsync,
35 TOnBlur,
36 TOnBlurAsync,
37 TOnSubmit,
38 TOnSubmitAsync,
39 TOnDynamic,
40 TOnDynamicAsync,
41 TOnServer,
42 TSubmitMeta
43 >
44}
45β
46/**
47 * Injects the form provided by an ancestor `[tanstack-with-form]` directive.
48 *
49 * Pass form options (typically the same options used to create the form) so
50 * the returned `form` is typed correctly without needing to specify generics:
51 *
52 * ```ts
53 * const withForm = injectWithForm({ ...peopleFormOpts })
54 * withForm.form // FormApi<PeopleFormData, ...>
55 * ```
56 *
57 * The options are only used for type inference and are not read at runtime.
58 */
59export function injectWithForm<
60 TFormData,
61 TOnMount extends undefined | FormValidateOrFn<TFormData>,
62 TOnChange extends undefined | FormValidateOrFn<TFormData>,
63 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
64 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
65 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
66 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
67 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
68 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
69 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
70 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
71 TSubmitMeta,
72>(
73 _opts?: FormOptions<
74 TFormData,
75 TOnMount,
76 TOnChange,
77 TOnChangeAsync,
78 TOnBlur,
79 TOnBlurAsync,
80 TOnSubmit,
81 TOnSubmitAsync,
82 TOnDynamic,
83 TOnDynamicAsync,
84 TOnServer,
85 TSubmitMeta
86 >,
87): TanStackWithFormRef<
88 TFormData,
89 TOnMount,
90 TOnChange,
91 TOnChangeAsync,
92 TOnBlur,
93 TOnBlurAsync,
94 TOnSubmit,
95 TOnSubmitAsync,
96 TOnDynamic,
97 TOnDynamicAsync,
98 TOnServer,
99 TSubmitMeta
100> {
101 const injectable = inject(TanStackWithFormInjectable)
102 return {
103 get form() {
104 return injectable._form() as FormApi<
105 TFormData,
106 TOnMount,
107 TOnChange,
108 TOnChangeAsync,
109 TOnBlur,
110 TOnBlurAsync,
111 TOnSubmit,
112 TOnSubmitAsync,
113 TOnDynamic,
114 TOnDynamicAsync,
115 TOnServer,
116 TSubmitMeta
117 >
118 },
119 }
120}