Open History to see the last commit
1import { FieldGroupApi, functionalUpdate } from '@tanstack/form-core'
2import { useStore } from '@tanstack/solid-store'
3import { onCleanup, onMount } from 'solid-js'
4import type { Component, JSX, ParentProps } from 'solid-js'
5import type {
6 DeepKeysOfType,
7 FieldGroupState,
8 FieldsMap,
9 FormAsyncValidateOrFn,
10 FormValidateOrFn,
11} from '@tanstack/form-core'
12import type { LensFieldComponent } from './createField'
13import type { AppFieldExtendedSolidFormApi } from './createFormHook'
14β
15/**
16 * @private
17 */
18export type AppFieldExtendedSolidFieldGroupApi<
19 TFormData,
20 TFieldGroupData,
21 TFields extends
22 | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
23 | FieldsMap<TFormData, TFieldGroupData>,
24 TOnMount extends undefined | FormValidateOrFn<TFormData>,
25 TOnChange extends undefined | FormValidateOrFn<TFormData>,
26 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
27 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
28 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
29 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
30 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
31 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
32 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
33 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
34 TSubmitMeta,
35 TFieldComponents extends Record<string, Component<any>>,
36 TFormComponents extends Record<string, Component<any>>,
37> = FieldGroupApi<
38 TFormData,
39 TFieldGroupData,
40 TFields,
41 TOnMount,
42 TOnChange,
43 TOnChangeAsync,
44 TOnBlur,
45 TOnBlurAsync,
46 TOnSubmit,
47 TOnSubmitAsync,
48 TOnDynamic,
49 TOnDynamicAsync,
50 TOnServer,
51 TSubmitMeta
52> &
53 NoInfer<TFormComponents> & {
54 AppField: LensFieldComponent<
55 TFieldGroupData,
56 TSubmitMeta,
57 NoInfer<TFieldComponents>
58 >
59 AppForm: Component<ParentProps>
60 /**
61 * A solid component to render form fields. With this, you can render and manage individual form fields.
62 */
63 Field: LensFieldComponent<TFieldGroupData, TSubmitMeta>
64β
65 /**
66 * A `Subscribe` function that allows you to listen and solid to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates.
67 */
68 Subscribe: <TSelected = NoInfer<FieldGroupState<TFieldGroupData>>>(props: {
69 selector?: (state: NoInfer<FieldGroupState<TFieldGroupData>>) => TSelected
70 children: ((state: NoInfer<TSelected>) => JSX.Element) | JSX.Element
71 }) => JSX.Element
72 }
73β
74export function createFieldGroup<
75 TFormData,
76 TFieldGroupData,
77 TFields extends
78 | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
79 | FieldsMap<TFormData, TFieldGroupData>,
80 TOnMount extends undefined | FormValidateOrFn<TFormData>,
81 TOnChange extends undefined | FormValidateOrFn<TFormData>,
82 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
83 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
84 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
85 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
86 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
87 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
88 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
89 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
90 TComponents extends Record<string, Component<any>>,
91 TFormComponents extends Record<string, Component<any>>,
92 TSubmitMeta = never,
93>(
94 opts: () => {
95 form:
96 | AppFieldExtendedSolidFormApi<
97 TFormData,
98 TOnMount,
99 TOnChange,
100 TOnChangeAsync,
101 TOnBlur,
102 TOnBlurAsync,
103 TOnSubmit,
104 TOnSubmitAsync,
105 TOnDynamic,
106 TOnDynamicAsync,
107 TOnServer,
108 TSubmitMeta,
109 TComponents,
110 TFormComponents
111 >
112 | AppFieldExtendedSolidFieldGroupApi<
113 // Since this only occurs if you nest it within other form lenses, it can be more
114 // lenient with the types.
115 unknown,
116 TFormData,
117 string | FieldsMap<unknown, TFormData>,
118 any,
119 any,
120 any,
121 any,
122 any,
123 any,
124 any,
125 any,
126 any,
127 any,
128 TSubmitMeta,
129 TComponents,
130 TFormComponents
131 >
132 fields: TFields
133 defaultValues?: TFieldGroupData
134 onSubmitMeta?: TSubmitMeta
135 formComponents: TFormComponents
136 },
137): AppFieldExtendedSolidFieldGroupApi<
138 TFormData,
139 TFieldGroupData,
140 TFields,
141 TOnMount,
142 TOnChange,
143 TOnChangeAsync,
144 TOnBlur,
145 TOnBlurAsync,
146 TOnSubmit,
147 TOnSubmitAsync,
148 TOnDynamic,
149 TOnDynamicAsync,
150 TOnServer,
151 TSubmitMeta,
152 TComponents,
153 TFormComponents
154> {
155 const options = opts()
156 const api = new FieldGroupApi(options)
157 const form =
158 options.form instanceof FieldGroupApi
159 ? (options.form.form as AppFieldExtendedSolidFormApi<
160 TFormData,
161 TOnMount,
162 TOnChange,
163 TOnChangeAsync,
164 TOnBlur,
165 TOnBlurAsync,
166 TOnSubmit,
167 TOnSubmitAsync,
168 TOnDynamic,
169 TOnDynamicAsync,
170 TOnServer,
171 TSubmitMeta,
172 TComponents,
173 TFormComponents
174 >)
175 : options.form
176β
177 const extendedApi: AppFieldExtendedSolidFieldGroupApi<
178 TFormData,
179 TFieldGroupData,
180 TFields,
181 TOnMount,
182 TOnChange,
183 TOnChangeAsync,
184 TOnBlur,
185 TOnBlurAsync,
186 TOnSubmit,
187 TOnSubmitAsync,
188 TOnDynamic,
189 TOnDynamicAsync,
190 TOnServer,
191 TSubmitMeta,
192 TComponents,
193 TFormComponents
194 > = api as never
195β
196 extendedApi.AppForm = (appFormProps) => <form.AppForm {...appFormProps} />
197 extendedApi.AppField = (props) => (
198 <form.AppField {...(api.getFormFieldOptions(props) as any)} />
199 )
200 extendedApi.Field = (props) => (
201 <form.Field {...(api.getFormFieldOptions(props) as any)} />
202 )
203 extendedApi.Subscribe = (props) => {
204 const data = useStore(api.store, props.selector)
205β
206 return functionalUpdate(props.children, data()) as Element
207 }
208β
209 let mounted = false
210 onMount(() => {
211 const cleanupFn = api.mount()
212 mounted = true
213 onCleanup(() => {
214 cleanupFn()
215 mounted = false
216 })
217 })
218β
219 return Object.assign(extendedApi, {
220 ...options.formComponents,
221 }) as AppFieldExtendedSolidFieldGroupApi<
222 TFormData,
223 TFieldGroupData,
224 TFields,
225 TOnMount,
226 TOnChange,
227 TOnChangeAsync,
228 TOnBlur,
229 TOnBlurAsync,
230 TOnSubmit,
231 TOnSubmitAsync,
232 TOnDynamic,
233 TOnDynamicAsync,
234 TOnServer,
235 TSubmitMeta,
236 TComponents,
237 TFormComponents
238 >
239}