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 [field, setField] = createSignal(fieldApi, { equals: false })
231 const unsubscribeStore = fieldApi.store.subscribe(() => setField(fieldApi))
232 onCleanup(unsubscribeStore)
233 return field
234}
235β
236export function createField<
237 TParentData,
238 TName extends DeepKeys<TParentData>,
239 TData extends DeepValue<TParentData, TName>,
240 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
241 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
242 TOnChangeAsync extends
243 | undefined
244 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
245 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
246 TOnBlurAsync extends
247 | undefined
248 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
249 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
250 TOnSubmitAsync extends
251 | undefined
252 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
253 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
254 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
255 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
256 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
257 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
258 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
259 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
260 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
261 TParentSubmitMeta,
262>(
263 opts: () => CreateFieldOptions<
264 TParentData,
265 TName,
266 TData,
267 TOnMount,
268 TOnChange,
269 TOnChangeAsync,
270 TOnBlur,
271 TOnBlurAsync,
272 TOnSubmit,
273 TOnSubmitAsync,
274 TFormOnMount,
275 TFormOnChange,
276 TFormOnChangeAsync,
277 TFormOnBlur,
278 TFormOnBlurAsync,
279 TFormOnSubmit,
280 TFormOnSubmitAsync,
281 TFormOnServer,
282 TParentSubmitMeta
283 >,
284) {
285 const options = opts()
286β
287 const api = new FieldApi(options)
288β
289 const extendedApi: typeof api &
290 SolidFieldApi<
291 TParentData,
292 TFormOnMount,
293 TFormOnChange,
294 TFormOnChangeAsync,
295 TFormOnBlur,
296 TFormOnBlurAsync,
297 TFormOnSubmit,
298 TFormOnSubmitAsync,
299 TFormOnServer,
300 TParentSubmitMeta
301 > = api as never
302β
303 extendedApi.Field = Field as never
304β
305 let mounted = false
306 // Instantiates field meta and removes it when unrendered
307 onMount(() => {
308 const cleanupFn = api.mount()
309 mounted = true
310 onCleanup(() => {
311 cleanupFn()
312 mounted = false
313 })
314 })
315β
316 /**
317 * fieldApi.update should not have any side effects. Think of it like a `useRef`
318 * that we need to keep updated every render with the most up-to-date information.
319 *
320 * createComputed to make sure this effect runs before render effects
321 */
322 createComputed(() => {
323 if (!mounted) return
324 api.update(opts())
325 })
326β
327 return makeFieldReactive<
328 TParentData,
329 TName,
330 TData,
331 TOnMount,
332 TOnChange,
333 TOnChangeAsync,
334 TOnBlur,
335 TOnBlurAsync,
336 TOnSubmit,
337 TOnSubmitAsync,
338 TFormOnMount,
339 TFormOnChange,
340 TFormOnChangeAsync,
341 TFormOnBlur,
342 TFormOnBlurAsync,
343 TFormOnSubmit,
344 TFormOnSubmitAsync,
345 TFormOnServer,
346 TParentSubmitMeta
347 >(extendedApi as never)
348}
349β
350type FieldComponentProps<
351 TParentData,
352 TName extends DeepKeys<TParentData>,
353 TData extends DeepValue<TParentData, TName>,
354 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
355 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
356 TOnChangeAsync extends
357 | undefined
358 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
359 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
360 TOnBlurAsync extends
361 | undefined
362 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
363 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
364 TOnSubmitAsync extends
365 | undefined
366 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
367 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
368 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
369 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
370 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
371 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
372 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
373 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
374 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
375 TParentSubmitMeta,
376> = {
377 children: (
378 fieldApi: () => FieldApi<
379 TParentData,
380 TName,
381 TData,
382 TOnMount,
383 TOnChange,
384 TOnChangeAsync,
385 TOnBlur,
386 TOnBlurAsync,
387 TOnSubmit,
388 TOnSubmitAsync,
389 TFormOnMount,
390 TFormOnChange,
391 TFormOnChangeAsync,
392 TFormOnBlur,
393 TFormOnBlurAsync,
394 TFormOnSubmit,
395 TFormOnSubmitAsync,
396 TFormOnServer,
397 TParentSubmitMeta
398 >,
399 ) => JSXElement
400} & Omit<
401 CreateFieldOptions<
402 TParentData,
403 TName,
404 TData,
405 TOnMount,
406 TOnChange,
407 TOnChangeAsync,
408 TOnBlur,
409 TOnBlurAsync,
410 TOnSubmit,
411 TOnSubmitAsync,
412 TFormOnMount,
413 TFormOnChange,
414 TFormOnChangeAsync,
415 TFormOnBlur,
416 TFormOnBlurAsync,
417 TFormOnSubmit,
418 TFormOnSubmitAsync,
419 TFormOnServer,
420 TParentSubmitMeta
421 >,
422 'form'
423>
424β
425export type FieldComponent<
426 TParentData,
427 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
428 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
429 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
430 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
431 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
432 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
433 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
434 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
435 TParentSubmitMeta,
436> = <
437 TName extends DeepKeys<TParentData>,
438 TData extends DeepValue<TParentData, TName>,
439 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
440 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
441 TOnChangeAsync extends
442 | undefined
443 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
444 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
445 TOnBlurAsync extends
446 | undefined
447 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
448 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
449 TOnSubmitAsync extends
450 | undefined
451 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
452>({
453 children,
454 ...fieldOptions
455}: Omit<
456 FieldComponentProps<
457 TParentData,
458 TName,
459 TData,
460 TOnMount,
461 TOnChange,
462 TOnChangeAsync,
463 TOnBlur,
464 TOnBlurAsync,
465 TOnSubmit,
466 TOnSubmitAsync,
467 TFormOnMount,
468 TFormOnChange,
469 TFormOnChangeAsync,
470 TFormOnBlur,
471 TFormOnBlurAsync,
472 TFormOnSubmit,
473 TFormOnSubmitAsync,
474 TFormOnServer,
475 TParentSubmitMeta
476 >,
477 'form'
478>) => JSXElement
479β
480export function Field<
481 TParentData,
482 TName extends DeepKeys<TParentData>,
483 TData extends DeepValue<TParentData, TName>,
484 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
485 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
486 TOnChangeAsync extends
487 | undefined
488 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
489 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
490 TOnBlurAsync extends
491 | undefined
492 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
493 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
494 TOnSubmitAsync extends
495 | undefined
496 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
497 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
498 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
499 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
500 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
501 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
502 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
503 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
504 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
505 TParentSubmitMeta,
506>(
507 props: {
508 children: (
509 fieldApi: () => FieldApi<
510 TParentData,
511 TName,
512 TData,
513 TOnMount,
514 TOnChange,
515 TOnChangeAsync,
516 TOnBlur,
517 TOnBlurAsync,
518 TOnSubmit,
519 TOnSubmitAsync,
520 TFormOnMount,
521 TFormOnChange,
522 TFormOnChangeAsync,
523 TFormOnBlur,
524 TFormOnBlurAsync,
525 TFormOnSubmit,
526 TFormOnSubmitAsync,
527 TFormOnServer,
528 TParentSubmitMeta
529 >,
530 ) => JSXElement
531 } & CreateFieldOptions<
532 TParentData,
533 TName,
534 TData,
535 TOnMount,
536 TOnChange,
537 TOnChangeAsync,
538 TOnBlur,
539 TOnBlurAsync,
540 TOnSubmit,
541 TOnSubmitAsync,
542 TFormOnMount,
543 TFormOnChange,
544 TFormOnChangeAsync,
545 TFormOnBlur,
546 TFormOnBlurAsync,
547 TFormOnSubmit,
548 TFormOnSubmitAsync,
549 TFormOnServer,
550 TParentSubmitMeta
551 >,
552) {
553 const fieldApi = createField<
554 TParentData,
555 TName,
556 TData,
557 TOnMount,
558 TOnChange,
559 TOnChangeAsync,
560 TOnBlur,
561 TOnBlurAsync,
562 TOnSubmit,
563 TOnSubmitAsync,
564 TFormOnMount,
565 TFormOnChange,
566 TFormOnChangeAsync,
567 TFormOnBlur,
568 TFormOnBlurAsync,
569 TFormOnSubmit,
570 TFormOnSubmitAsync,
571 TFormOnServer,
572 TParentSubmitMeta
573 >(() => {
574 const { children, ...fieldOptions } = props
575 return fieldOptions
576 })
577β
578 return <>{createComponent(() => props.children(fieldApi), {})}</>
579}