Open History to see the last commit
1import { FieldApi } from '@tanstack/form-core'
2import {
3 createComponent,
4 createComputed,
5 createMemo,
6 createSignal,
7 onCleanup,
8 onMount,
9} from 'solid-js'
10import type {
11 DeepKeys,
12 DeepValue,
13 FieldAsyncValidateOrFn,
14 FieldValidateOrFn,
15 FormAsyncValidateOrFn,
16 FormValidateOrFn,
17 Narrow,
18} from '@tanstack/form-core'
19β
20import type { JSXElement } from 'solid-js'
21import type { CreateFieldOptions } from './types'
22β
23interface SolidFieldApi<
24 TParentData,
25 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
26 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
27 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
28 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
29 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
30 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
31 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
32 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
33 TParentSubmitMeta,
34> {
35 Field: FieldComponent<
36 TParentData,
37 TFormOnMount,
38 TFormOnChange,
39 TFormOnChangeAsync,
40 TFormOnBlur,
41 TFormOnBlurAsync,
42 TFormOnSubmit,
43 TFormOnSubmitAsync,
44 TFormOnServer,
45 TParentSubmitMeta
46 >
47}
48β
49export type CreateField<
50 TParentData,
51 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
52 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
53 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
54 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
55 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
56 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
57 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
58 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
59 TParentSubmitMeta,
60> = <
61 TName extends DeepKeys<TParentData>,
62 TData extends DeepValue<TParentData, TName>,
63 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
64 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
65 TOnChangeAsync extends
66 | undefined
67 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
68 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
69 TOnBlurAsync extends
70 | undefined
71 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
72 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
73 TOnSubmitAsync extends
74 | undefined
75 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
76 TSubmitMeta,
77>(
78 opts: () => { name: Narrow<TName> } & Omit<
79 CreateFieldOptions<
80 TParentData,
81 TName,
82 TData,
83 TOnMount,
84 TOnChange,
85 TOnChangeAsync,
86 TOnBlur,
87 TOnBlurAsync,
88 TOnSubmit,
89 TOnSubmitAsync,
90 TFormOnMount,
91 TFormOnChange,
92 TFormOnChangeAsync,
93 TFormOnBlur,
94 TFormOnBlurAsync,
95 TFormOnSubmit,
96 TFormOnSubmitAsync,
97 TFormOnServer,
98 TSubmitMeta
99 >,
100 'form'
101 >,
102) => () => FieldApi<
103 TParentData,
104 TName,
105 TData,
106 TOnMount,
107 TOnChange,
108 TOnChangeAsync,
109 TOnBlur,
110 TOnBlurAsync,
111 TOnSubmit,
112 TOnSubmitAsync,
113 TFormOnMount,
114 TFormOnChange,
115 TFormOnChangeAsync,
116 TFormOnBlur,
117 TFormOnBlurAsync,
118 TFormOnSubmit,
119 TFormOnSubmitAsync,
120 TFormOnServer,
121 TParentSubmitMeta
122> &
123 SolidFieldApi<
124 TParentData,
125 TFormOnMount,
126 TFormOnChange,
127 TFormOnChangeAsync,
128 TFormOnBlur,
129 TFormOnBlurAsync,
130 TFormOnSubmit,
131 TFormOnSubmitAsync,
132 TFormOnServer,
133 TParentSubmitMeta
134 >
135β
136// ugly way to trick solid into triggering updates for changes on the fieldApi
137function makeFieldReactive<
138 TParentData,
139 TName extends DeepKeys<TParentData>,
140 TData extends DeepValue<TParentData, TName>,
141 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
142 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
143 TOnChangeAsync extends
144 | undefined
145 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
146 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
147 TOnBlurAsync extends
148 | undefined
149 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
150 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
151 TOnSubmitAsync extends
152 | undefined
153 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
154 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
155 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
156 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
157 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
158 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
159 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
160 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
161 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
162 TParentSubmitMeta,
163>(
164 fieldApi: FieldApi<
165 TParentData,
166 TName,
167 TData,
168 TOnMount,
169 TOnChange,
170 TOnChangeAsync,
171 TOnBlur,
172 TOnBlurAsync,
173 TOnSubmit,
174 TOnSubmitAsync,
175 TFormOnMount,
176 TFormOnChange,
177 TFormOnChangeAsync,
178 TFormOnBlur,
179 TFormOnBlurAsync,
180 TFormOnSubmit,
181 TFormOnSubmitAsync,
182 TFormOnServer,
183 TParentSubmitMeta
184 > &
185 SolidFieldApi<
186 TParentData,
187 TFormOnMount,
188 TFormOnChange,
189 TFormOnChangeAsync,
190 TFormOnBlur,
191 TFormOnBlurAsync,
192 TFormOnSubmit,
193 TFormOnSubmitAsync,
194 TFormOnServer,
195 TParentSubmitMeta
196 >,
197): () => FieldApi<
198 TParentData,
199 TName,
200 TData,
201 TOnMount,
202 TOnChange,
203 TOnChangeAsync,
204 TOnBlur,
205 TOnBlurAsync,
206 TOnSubmit,
207 TOnSubmitAsync,
208 TFormOnMount,
209 TFormOnChange,
210 TFormOnChangeAsync,
211 TFormOnBlur,
212 TFormOnBlurAsync,
213 TFormOnSubmit,
214 TFormOnSubmitAsync,
215 TFormOnServer,
216 TParentSubmitMeta
217> &
218 SolidFieldApi<
219 TParentData,
220 TFormOnMount,
221 TFormOnChange,
222 TFormOnChangeAsync,
223 TFormOnBlur,
224 TFormOnBlurAsync,
225 TFormOnSubmit,
226 TFormOnSubmitAsync,
227 TFormOnServer,
228 TParentSubmitMeta
229 > {
230 const [flag, setFlag] = createSignal(false)
231 const fieldApiMemo = createMemo(() => [flag(), fieldApi] as const)
232 const unsubscribeStore = fieldApi.store.subscribe(() => setFlag((f) => !f))
233 onCleanup(unsubscribeStore)
234 return () => fieldApiMemo()[1]
235}
236β
237export function createField<
238 TParentData,
239 TName extends DeepKeys<TParentData>,
240 TData extends DeepValue<TParentData, TName>,
241 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
242 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
243 TOnChangeAsync extends
244 | undefined
245 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
246 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
247 TOnBlurAsync extends
248 | undefined
249 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
250 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
251 TOnSubmitAsync extends
252 | undefined
253 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
254 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
255 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
256 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
257 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
258 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
259 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
260 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
261 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
262 TParentSubmitMeta,
263>(
264 opts: () => CreateFieldOptions<
265 TParentData,
266 TName,
267 TData,
268 TOnMount,
269 TOnChange,
270 TOnChangeAsync,
271 TOnBlur,
272 TOnBlurAsync,
273 TOnSubmit,
274 TOnSubmitAsync,
275 TFormOnMount,
276 TFormOnChange,
277 TFormOnChangeAsync,
278 TFormOnBlur,
279 TFormOnBlurAsync,
280 TFormOnSubmit,
281 TFormOnSubmitAsync,
282 TFormOnServer,
283 TParentSubmitMeta
284 >,
285) {
286 const options = opts()
287β
288 const api = new FieldApi(options)
289β
290 const extendedApi: typeof api &
291 SolidFieldApi<
292 TParentData,
293 TFormOnMount,
294 TFormOnChange,
295 TFormOnChangeAsync,
296 TFormOnBlur,
297 TFormOnBlurAsync,
298 TFormOnSubmit,
299 TFormOnSubmitAsync,
300 TFormOnServer,
301 TParentSubmitMeta
302 > = api as never
303β
304 extendedApi.Field = Field as never
305β
306 let mounted = false
307 // Instantiates field meta and removes it when unrendered
308 onMount(() => {
309 const cleanupFn = api.mount()
310 mounted = true
311 onCleanup(() => {
312 cleanupFn()
313 mounted = false
314 })
315 })
316β
317 /**
318 * fieldApi.update should not have any side effects. Think of it like a `useRef`
319 * that we need to keep updated every render with the most up-to-date information.
320 *
321 * createComputed to make sure this effect runs before render effects
322 */
323 createComputed(() => {
324 if (!mounted) return
325 api.update(opts())
326 })
327β
328 return makeFieldReactive<
329 TParentData,
330 TName,
331 TData,
332 TOnMount,
333 TOnChange,
334 TOnChangeAsync,
335 TOnBlur,
336 TOnBlurAsync,
337 TOnSubmit,
338 TOnSubmitAsync,
339 TFormOnMount,
340 TFormOnChange,
341 TFormOnChangeAsync,
342 TFormOnBlur,
343 TFormOnBlurAsync,
344 TFormOnSubmit,
345 TFormOnSubmitAsync,
346 TFormOnServer,
347 TParentSubmitMeta
348 >(extendedApi as never)
349}
350β
351type FieldComponentProps<
352 TParentData,
353 TName extends DeepKeys<TParentData>,
354 TData extends DeepValue<TParentData, TName>,
355 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
356 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
357 TOnChangeAsync extends
358 | undefined
359 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
360 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
361 TOnBlurAsync extends
362 | undefined
363 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
364 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
365 TOnSubmitAsync extends
366 | undefined
367 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
368 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
369 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
370 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
371 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
372 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
373 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
374 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
375 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
376 TParentSubmitMeta,
377> = {
378 children: (
379 fieldApi: () => FieldApi<
380 TParentData,
381 TName,
382 TData,
383 TOnMount,
384 TOnChange,
385 TOnChangeAsync,
386 TOnBlur,
387 TOnBlurAsync,
388 TOnSubmit,
389 TOnSubmitAsync,
390 TFormOnMount,
391 TFormOnChange,
392 TFormOnChangeAsync,
393 TFormOnBlur,
394 TFormOnBlurAsync,
395 TFormOnSubmit,
396 TFormOnSubmitAsync,
397 TFormOnServer,
398 TParentSubmitMeta
399 >,
400 ) => JSXElement
401} & Omit<
402 CreateFieldOptions<
403 TParentData,
404 TName,
405 TData,
406 TOnMount,
407 TOnChange,
408 TOnChangeAsync,
409 TOnBlur,
410 TOnBlurAsync,
411 TOnSubmit,
412 TOnSubmitAsync,
413 TFormOnMount,
414 TFormOnChange,
415 TFormOnChangeAsync,
416 TFormOnBlur,
417 TFormOnBlurAsync,
418 TFormOnSubmit,
419 TFormOnSubmitAsync,
420 TFormOnServer,
421 TParentSubmitMeta
422 >,
423 'form'
424>
425β
426export type FieldComponent<
427 TParentData,
428 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
429 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
430 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
431 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
432 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
433 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
434 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
435 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
436 TParentSubmitMeta,
437> = <
438 TName extends DeepKeys<TParentData>,
439 TData extends DeepValue<TParentData, TName>,
440 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
441 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
442 TOnChangeAsync extends
443 | undefined
444 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
445 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
446 TOnBlurAsync extends
447 | undefined
448 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
449 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
450 TOnSubmitAsync extends
451 | undefined
452 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
453>({
454 children,
455 ...fieldOptions
456}: Omit<
457 FieldComponentProps<
458 TParentData,
459 TName,
460 TData,
461 TOnMount,
462 TOnChange,
463 TOnChangeAsync,
464 TOnBlur,
465 TOnBlurAsync,
466 TOnSubmit,
467 TOnSubmitAsync,
468 TFormOnMount,
469 TFormOnChange,
470 TFormOnChangeAsync,
471 TFormOnBlur,
472 TFormOnBlurAsync,
473 TFormOnSubmit,
474 TFormOnSubmitAsync,
475 TFormOnServer,
476 TParentSubmitMeta
477 >,
478 'form'
479>) => JSXElement
480β
481export function Field<
482 TParentData,
483 TName extends DeepKeys<TParentData>,
484 TData extends DeepValue<TParentData, TName>,
485 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
486 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
487 TOnChangeAsync extends
488 | undefined
489 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
490 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
491 TOnBlurAsync extends
492 | undefined
493 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
494 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
495 TOnSubmitAsync extends
496 | undefined
497 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
498 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
499 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
500 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
501 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
502 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
503 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
504 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
505 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
506 TParentSubmitMeta,
507>(
508 props: {
509 children: (
510 fieldApi: () => FieldApi<
511 TParentData,
512 TName,
513 TData,
514 TOnMount,
515 TOnChange,
516 TOnChangeAsync,
517 TOnBlur,
518 TOnBlurAsync,
519 TOnSubmit,
520 TOnSubmitAsync,
521 TFormOnMount,
522 TFormOnChange,
523 TFormOnChangeAsync,
524 TFormOnBlur,
525 TFormOnBlurAsync,
526 TFormOnSubmit,
527 TFormOnSubmitAsync,
528 TFormOnServer,
529 TParentSubmitMeta
530 >,
531 ) => JSXElement
532 } & CreateFieldOptions<
533 TParentData,
534 TName,
535 TData,
536 TOnMount,
537 TOnChange,
538 TOnChangeAsync,
539 TOnBlur,
540 TOnBlurAsync,
541 TOnSubmit,
542 TOnSubmitAsync,
543 TFormOnMount,
544 TFormOnChange,
545 TFormOnChangeAsync,
546 TFormOnBlur,
547 TFormOnBlurAsync,
548 TFormOnSubmit,
549 TFormOnSubmitAsync,
550 TFormOnServer,
551 TParentSubmitMeta
552 >,
553) {
554 const fieldApi = createField<
555 TParentData,
556 TName,
557 TData,
558 TOnMount,
559 TOnChange,
560 TOnChangeAsync,
561 TOnBlur,
562 TOnBlurAsync,
563 TOnSubmit,
564 TOnSubmitAsync,
565 TFormOnMount,
566 TFormOnChange,
567 TFormOnChangeAsync,
568 TFormOnBlur,
569 TFormOnBlurAsync,
570 TFormOnSubmit,
571 TFormOnSubmitAsync,
572 TFormOnServer,
573 TParentSubmitMeta
574 >(() => {
575 const { children, ...fieldOptions } = props
576 return fieldOptions
577 })
578β
579 return <>{createComponent(() => props.children(fieldApi), {})}</>
580}