Open History to see the last commit
1import { FormApi, functionalUpdate } from '@tanstack/form-core'
2import { createComputed, onMount } from 'solid-js'
3import { useSelector } from '@tanstack/solid-store'
4import { Field, createField } from './createField'
5import { FormGroup } from './createFormGroup'
6import type {
7 FormAsyncValidateOrFn,
8 FormOptions,
9 FormState,
10 FormValidateOrFn,
11} from '@tanstack/form-core'
12import type { JSXElement } from 'solid-js'
13import type { FieldComponent } from './createField'
14import type { FormGroupComponent } from './createFormGroup'
15β
16export interface SolidFormApi<
17 TParentData,
18 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
19 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
20 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
21 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
22 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
23 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
24 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
25 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
26 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
27 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
28 TSubmitMeta,
29> {
30 Field: FieldComponent<
31 TParentData,
32 TFormOnMount,
33 TFormOnChange,
34 TFormOnChangeAsync,
35 TFormOnBlur,
36 TFormOnBlurAsync,
37 TFormOnSubmit,
38 TFormOnSubmitAsync,
39 TFormOnDynamic,
40 TFormOnDynamicAsync,
41 TFormOnServer,
42 TSubmitMeta
43 >
44 FormGroup: FormGroupComponent<
45 TParentData,
46 TFormOnMount,
47 TFormOnChange,
48 TFormOnChangeAsync,
49 TFormOnBlur,
50 TFormOnBlurAsync,
51 TFormOnSubmit,
52 TFormOnSubmitAsync,
53 TFormOnDynamic,
54 TFormOnDynamicAsync,
55 TFormOnServer,
56 TSubmitMeta
57 >
58 useSelector: <
59 TSelected = NoInfer<
60 FormState<
61 TParentData,
62 TFormOnMount,
63 TFormOnChange,
64 TFormOnChangeAsync,
65 TFormOnBlur,
66 TFormOnBlurAsync,
67 TFormOnSubmit,
68 TFormOnSubmitAsync,
69 TFormOnDynamic,
70 TFormOnDynamicAsync,
71 TFormOnServer
72 >
73 >,
74 >(
75 selector?: (
76 state: NoInfer<
77 FormState<
78 TParentData,
79 TFormOnMount,
80 TFormOnChange,
81 TFormOnChangeAsync,
82 TFormOnBlur,
83 TFormOnBlurAsync,
84 TFormOnSubmit,
85 TFormOnSubmitAsync,
86 TFormOnDynamic,
87 TFormOnDynamicAsync,
88 TFormOnServer
89 >
90 >,
91 ) => TSelected,
92 ) => () => TSelected
93 /**
94 * @deprecated Use `form.useSelector` instead.
95 */
96 useStore: <
97 TSelected = NoInfer<
98 FormState<
99 TParentData,
100 TFormOnMount,
101 TFormOnChange,
102 TFormOnChangeAsync,
103 TFormOnBlur,
104 TFormOnBlurAsync,
105 TFormOnSubmit,
106 TFormOnSubmitAsync,
107 TFormOnDynamic,
108 TFormOnDynamicAsync,
109 TFormOnServer
110 >
111 >,
112 >(
113 selector?: (
114 state: NoInfer<
115 FormState<
116 TParentData,
117 TFormOnMount,
118 TFormOnChange,
119 TFormOnChangeAsync,
120 TFormOnBlur,
121 TFormOnBlurAsync,
122 TFormOnSubmit,
123 TFormOnSubmitAsync,
124 TFormOnDynamic,
125 TFormOnDynamicAsync,
126 TFormOnServer
127 >
128 >,
129 ) => TSelected,
130 ) => () => TSelected
131 Subscribe: <
132 TSelected = NoInfer<
133 FormState<
134 TParentData,
135 TFormOnMount,
136 TFormOnChange,
137 TFormOnChangeAsync,
138 TFormOnBlur,
139 TFormOnBlurAsync,
140 TFormOnSubmit,
141 TFormOnSubmitAsync,
142 TFormOnDynamic,
143 TFormOnDynamicAsync,
144 TFormOnServer
145 >
146 >,
147 >(props: {
148 selector?: (
149 state: NoInfer<
150 FormState<
151 TParentData,
152 TFormOnMount,
153 TFormOnChange,
154 TFormOnChangeAsync,
155 TFormOnBlur,
156 TFormOnBlurAsync,
157 TFormOnSubmit,
158 TFormOnSubmitAsync,
159 TFormOnDynamic,
160 TFormOnDynamicAsync,
161 TFormOnServer
162 >
163 >,
164 ) => TSelected
165 children: ((state: () => NoInfer<TSelected>) => JSXElement) | JSXElement
166 }) => JSXElement
167}
168β
169/**
170 * An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi`
171 */
172export type SolidFormExtendedApi<
173 TFormData,
174 TOnMount extends undefined | FormValidateOrFn<TFormData>,
175 TOnChange extends undefined | FormValidateOrFn<TFormData>,
176 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
177 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
178 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
179 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
180 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
181 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
182 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
183 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
184 TSubmitMeta,
185> = FormApi<
186 TFormData,
187 TOnMount,
188 TOnChange,
189 TOnChangeAsync,
190 TOnBlur,
191 TOnBlurAsync,
192 TOnSubmit,
193 TOnSubmitAsync,
194 TOnDynamic,
195 TOnDynamicAsync,
196 TOnServer,
197 TSubmitMeta
198> &
199 SolidFormApi<
200 TFormData,
201 TOnMount,
202 TOnChange,
203 TOnChangeAsync,
204 TOnBlur,
205 TOnBlurAsync,
206 TOnSubmit,
207 TOnSubmitAsync,
208 TOnDynamic,
209 TOnDynamicAsync,
210 TOnServer,
211 TSubmitMeta
212 >
213export function createForm<
214 TParentData,
215 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
216 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
217 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
218 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
219 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
220 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
221 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
222 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
223 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
224 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
225 TSubmitMeta,
226>(
227 opts?: () => FormOptions<
228 TParentData,
229 TFormOnMount,
230 TFormOnChange,
231 TFormOnChangeAsync,
232 TFormOnBlur,
233 TFormOnBlurAsync,
234 TFormOnSubmit,
235 TFormOnSubmitAsync,
236 TFormOnDynamic,
237 TFormOnDynamicAsync,
238 TFormOnServer,
239 TSubmitMeta
240 >,
241) {
242 const options = opts?.()
243 const api = new FormApi<
244 TParentData,
245 TFormOnMount,
246 TFormOnChange,
247 TFormOnChangeAsync,
248 TFormOnBlur,
249 TFormOnBlurAsync,
250 TFormOnSubmit,
251 TFormOnSubmitAsync,
252 TFormOnDynamic,
253 TFormOnDynamicAsync,
254 TFormOnServer,
255 TSubmitMeta
256 >(options)
257 const extendedApi: typeof api &
258 SolidFormApi<
259 TParentData,
260 TFormOnMount,
261 TFormOnChange,
262 TFormOnChangeAsync,
263 TFormOnBlur,
264 TFormOnBlurAsync,
265 TFormOnSubmit,
266 TFormOnSubmitAsync,
267 TFormOnDynamic,
268 TFormOnDynamicAsync,
269 TFormOnServer,
270 TSubmitMeta
271 > = api as never
272β
273 extendedApi.Field = (props) => <Field {...props} form={api} />
274 extendedApi.FormGroup = (props) => <FormGroup {...props} form={api} />
275 extendedApi.useSelector = (selector) => useSelector(api.store, selector)
276 /** @deprecated Use `form.useSelector` instead. */
277 extendedApi.useStore = extendedApi.useSelector
278 extendedApi.Subscribe = (props) =>
279 functionalUpdate(props.children, useSelector(api.store, props.selector))
280β
281 onMount(api.mount)
282β
283 /**
284 * formApi.update should not have any side effects. Think of it like a `useRef`
285 * that we need to keep updated every render with the most up-to-date information.
286 */
287 createComputed(() => api.update(opts?.()))
288β
289 return extendedApi
290}