Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

createField.tsx

813 lines23.4 KB

1import { FieldApi } from '@tanstack/form-core'
2import {
3 createComponent,
4 createComputed,
5 createSignal,
6 onCleanup,
7 onMount,
8} from 'solid-js'
9import { useStore } from '@tanstack/solid-store'
10import type {
11 DeepKeys,
12 DeepValue,
13 FieldAsyncValidateOrFn,
14 FieldValidateOrFn,
15 FieldValidators,
16 FormAsyncValidateOrFn,
17 FormValidateOrFn,
18 Narrow,
19} from '@tanstack/form-core'
20​
21import type { Accessor, JSX, JSXElement } from 'solid-js'
22import type { CreateFieldOptions, CreateFieldOptionsBound } from './types'
23​
24interface SolidFieldApi<
25 TParentData,
26 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
27 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
28 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
29 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
30 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
31 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
32 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
33 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
34 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
35 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
36 TParentSubmitMeta,
37> {
38 Field: FieldComponent<
39 TParentData,
40 TFormOnMount,
41 TFormOnChange,
42 TFormOnChangeAsync,
43 TFormOnBlur,
44 TFormOnBlurAsync,
45 TFormOnSubmit,
46 TFormOnSubmitAsync,
47 TFormOnDynamic,
48 TFormOnDynamicAsync,
49 TFormOnServer,
50 TParentSubmitMeta
51 >
53​
54export type CreateField<
55 TParentData,
56 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
57 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
58 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
59 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
60 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
61 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
62 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
63 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
64 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
65 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
66 TParentSubmitMeta,
67> = <
68 TName extends DeepKeys<TParentData>,
69 TData extends DeepValue<TParentData, TName>,
70 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
71 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
72 TOnChangeAsync extends
73 | undefined
74 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
75 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
76 TOnBlurAsync extends
77 | undefined
78 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
79 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
80 TOnSubmitAsync extends
81 | undefined
82 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
83 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
84 TOnDynamicAsync extends
85 | undefined
86 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
87>(
88 opts: () => { name: Narrow<TName> } & CreateFieldOptionsBound<
89 TParentData,
90 TName,
91 TData,
92 TOnMount,
93 TOnChange,
94 TOnChangeAsync,
95 TOnBlur,
96 TOnBlurAsync,
97 TOnSubmit,
98 TOnSubmitAsync,
99 TOnDynamic,
100 TOnDynamicAsync
101 >,
102) => () => FieldApi<
103 TParentData,
104 TName,
105 TData,
106 TOnMount,
107 TOnChange,
108 TOnChangeAsync,
109 TOnBlur,
110 TOnBlurAsync,
111 TOnSubmit,
112 TOnSubmitAsync,
113 TOnDynamic,
114 TOnDynamicAsync,
115 TFormOnMount,
116 TFormOnChange,
117 TFormOnChangeAsync,
118 TFormOnBlur,
119 TFormOnBlurAsync,
120 TFormOnSubmit,
121 TFormOnSubmitAsync,
122 TFormOnDynamic,
123 TFormOnDynamicAsync,
124 TFormOnServer,
125 TParentSubmitMeta
126> &
127 SolidFieldApi<
128 TParentData,
129 TFormOnMount,
130 TFormOnChange,
131 TFormOnChangeAsync,
132 TFormOnBlur,
133 TFormOnBlurAsync,
134 TFormOnSubmit,
135 TFormOnSubmitAsync,
136 TFormOnDynamic,
137 TFormOnDynamicAsync,
138 TFormOnServer,
139 TParentSubmitMeta
140 >
141​
142// ugly way to trick solid into triggering updates for changes on the fieldApi
143function makeFieldReactive<
144 TParentData,
145 TName extends DeepKeys<TParentData>,
146 TData extends DeepValue<TParentData, TName>,
147 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
148 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
149 TOnChangeAsync extends
150 | undefined
151 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
152 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
153 TOnBlurAsync extends
154 | undefined
155 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
156 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
157 TOnSubmitAsync extends
158 | undefined
159 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
160 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
161 TOnDynamicAsync extends
162 | undefined
163 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
164 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
165 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
166 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
167 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
168 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
169 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
170 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
171 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
172 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
173 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
174 TParentSubmitMeta,
175>(
176 fieldApi: FieldApi<
177 TParentData,
178 TName,
179 TData,
180 TOnMount,
181 TOnChange,
182 TOnChangeAsync,
183 TOnBlur,
184 TOnBlurAsync,
185 TOnSubmit,
186 TOnSubmitAsync,
187 TOnDynamic,
188 TOnDynamicAsync,
189 TFormOnMount,
190 TFormOnChange,
191 TFormOnChangeAsync,
192 TFormOnBlur,
193 TFormOnBlurAsync,
194 TFormOnSubmit,
195 TFormOnSubmitAsync,
196 TFormOnDynamic,
197 TFormOnDynamicAsync,
198 TFormOnServer,
199 TParentSubmitMeta
200 > &
201 SolidFieldApi<
202 TParentData,
203 TFormOnMount,
204 TFormOnChange,
205 TFormOnChangeAsync,
206 TFormOnBlur,
207 TFormOnBlurAsync,
208 TFormOnSubmit,
209 TFormOnSubmitAsync,
210 TFormOnDynamic,
211 TFormOnDynamicAsync,
212 TFormOnServer,
213 TParentSubmitMeta
214 >,
215): () => FieldApi<
216 TParentData,
217 TName,
218 TData,
219 TOnMount,
220 TOnChange,
221 TOnChangeAsync,
222 TOnBlur,
223 TOnBlurAsync,
224 TOnSubmit,
225 TOnSubmitAsync,
226 TOnDynamic,
227 TOnDynamicAsync,
228 TFormOnMount,
229 TFormOnChange,
230 TFormOnChangeAsync,
231 TFormOnBlur,
232 TFormOnBlurAsync,
233 TFormOnSubmit,
234 TFormOnSubmitAsync,
235 TFormOnDynamic,
236 TFormOnDynamicAsync,
237 TFormOnServer,
238 TParentSubmitMeta
239> &
240 SolidFieldApi<
241 TParentData,
242 TFormOnMount,
243 TFormOnChange,
244 TFormOnChangeAsync,
245 TFormOnBlur,
246 TFormOnBlurAsync,
247 TFormOnSubmit,
248 TFormOnSubmitAsync,
249 TFormOnDynamic,
250 TFormOnDynamicAsync,
251 TFormOnServer,
252 TParentSubmitMeta
253 > {
254 const [field, setField] = createSignal(fieldApi, { equals: false })
255 // Handle shallow comparison to make sure that Derived doesn't create a new setField call every time
256 const store = useStore(fieldApi.store, (store) => store)
257 // Run before initial render
258 createComputed(() => {
259 // Use the store to track dependencies
260 store()
261 setField(fieldApi)
262 })
263 return field
265​
266export function createField<
267 TParentData,
268 TName extends DeepKeys<TParentData>,
269 TData extends DeepValue<TParentData, TName>,
270 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
271 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
272 TOnChangeAsync extends
273 | undefined
274 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
275 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
276 TOnBlurAsync extends
277 | undefined
278 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
279 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
280 TOnSubmitAsync extends
281 | undefined
282 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
283 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
284 TOnDynamicAsync extends
285 | undefined
286 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
287 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
288 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
289 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
290 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
291 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
292 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
293 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
294 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
295 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
296 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
297 TParentSubmitMeta,
298>(
299 opts: () => CreateFieldOptions<
300 TParentData,
301 TName,
302 TData,
303 TOnMount,
304 TOnChange,
305 TOnChangeAsync,
306 TOnBlur,
307 TOnBlurAsync,
308 TOnSubmit,
309 TOnSubmitAsync,
310 TOnDynamic,
311 TOnDynamicAsync,
312 TFormOnMount,
313 TFormOnChange,
314 TFormOnChangeAsync,
315 TFormOnBlur,
316 TFormOnBlurAsync,
317 TFormOnSubmit,
318 TFormOnSubmitAsync,
319 TFormOnDynamic,
320 TFormOnDynamicAsync,
321 TFormOnServer,
322 TParentSubmitMeta
323 >,
324) {
325 const options = opts()
326​
327 const api = new FieldApi(options)
328​
329 const extendedApi: typeof api &
330 SolidFieldApi<
331 TParentData,
332 TFormOnMount,
333 TFormOnChange,
334 TFormOnChangeAsync,
335 TFormOnBlur,
336 TFormOnBlurAsync,
337 TFormOnSubmit,
338 TFormOnSubmitAsync,
339 TFormOnDynamic,
340 TFormOnDynamicAsync,
341 TFormOnServer,
342 TParentSubmitMeta
343 > = api as never
344​
345 extendedApi.Field = Field as never
346​
347 let mounted = false
348 // Instantiates field meta and removes it when unrendered
349 onMount(() => {
350 const cleanupFn = api.mount()
351 mounted = true
352 onCleanup(() => {
353 cleanupFn()
354 mounted = false
355 })
356 })
357​
358 /**
359 * fieldApi.update should not have any side effects. Think of it like a `useRef`
360 * that we need to keep updated every render with the most up-to-date information.
361 *
362 * createComputed to make sure this effect runs before render effects
363 */
364 createComputed(() => {
365 if (!mounted) return
366 api.update(opts())
367 })
368​
369 return makeFieldReactive<
370 TParentData,
371 TName,
372 TData,
373 TOnMount,
374 TOnChange,
375 TOnChangeAsync,
376 TOnBlur,
377 TOnBlurAsync,
378 TOnSubmit,
379 TOnSubmitAsync,
380 TOnDynamic,
381 TOnDynamicAsync,
382 TFormOnMount,
383 TFormOnChange,
384 TFormOnChangeAsync,
385 TFormOnBlur,
386 TFormOnBlurAsync,
387 TFormOnSubmit,
388 TFormOnSubmitAsync,
389 TFormOnDynamic,
390 TFormOnDynamicAsync,
391 TFormOnServer,
392 TParentSubmitMeta
393 >(extendedApi as never)
395​
396interface FieldComponentBoundProps<
397 TParentData,
398 TName extends DeepKeys<TParentData>,
399 TData extends DeepValue<TParentData, TName>,
400 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
401 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
402 TOnChangeAsync extends
403 | undefined
404 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
405 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
406 TOnBlurAsync extends
407 | undefined
408 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
409 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
410 TOnSubmitAsync extends
411 | undefined
412 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
413 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
414 TOnDynamicAsync extends
415 | undefined
416 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
417 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
418 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
419 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
420 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
421 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
422 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
423 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
424 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
425 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
426 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
427 TPatentSubmitMeta,
428 ExtendedApi = {},
429> extends CreateFieldOptionsBound<
430 TParentData,
431 TName,
432 TData,
433 TOnMount,
434 TOnChange,
435 TOnChangeAsync,
436 TOnBlur,
437 TOnBlurAsync,
438 TOnSubmit,
439 TOnSubmitAsync,
440 TOnDynamic,
441 TOnDynamicAsync
442> {
443 children: (
444 fieldApi: Accessor<
445 FieldApi<
446 TParentData,
447 TName,
448 TData,
449 TOnMount,
450 TOnChange,
451 TOnChangeAsync,
452 TOnBlur,
453 TOnBlurAsync,
454 TOnSubmit,
455 TOnSubmitAsync,
456 TOnDynamic,
457 TOnDynamicAsync,
458 TFormOnMount,
459 TFormOnChange,
460 TFormOnChangeAsync,
461 TFormOnBlur,
462 TFormOnBlurAsync,
463 TFormOnSubmit,
464 TFormOnSubmitAsync,
465 TFormOnDynamic,
466 TFormOnDynamicAsync,
467 TFormOnServer,
468 TPatentSubmitMeta
469 >
470 > &
471 ExtendedApi,
472 ) => JSX.Element
474​
475/**
476 * A type alias representing a field component for a specific form data type.
477 */
478export type FieldComponent<
479 in out TParentData,
480 in out TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
481 in out TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
482 in out TFormOnChangeAsync extends
483 | undefined
484 | FormAsyncValidateOrFn<TParentData>,
485 in out TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
486 in out TFormOnBlurAsync extends
487 | undefined
488 | FormAsyncValidateOrFn<TParentData>,
489 in out TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
490 in out TFormOnSubmitAsync extends
491 | undefined
492 | FormAsyncValidateOrFn<TParentData>,
493 in out TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
494 in out TFormOnDynamicAsync extends
495 | undefined
496 | FormAsyncValidateOrFn<TParentData>,
497 in out TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
498 in out TPatentSubmitMeta,
499 in out ExtendedApi = {},
500> = <
501 const TName extends DeepKeys<TParentData>,
502 TData extends DeepValue<TParentData, TName>,
503 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
504 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
505 TOnChangeAsync extends
506 | undefined
507 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
508 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
509 TOnBlurAsync extends
510 | undefined
511 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
512 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
513 TOnSubmitAsync extends
514 | undefined
515 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
516 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
517 TOnDynamicAsync extends
518 | undefined
519 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
520>({
521 children,
522 ...fieldOptions
523}: FieldComponentBoundProps<
524 TParentData,
525 TName,
526 TData,
527 TOnMount,
528 TOnChange,
529 TOnChangeAsync,
530 TOnBlur,
531 TOnBlurAsync,
532 TOnSubmit,
533 TOnSubmitAsync,
534 TOnDynamic,
535 TOnDynamicAsync,
536 TFormOnMount,
537 TFormOnChange,
538 TFormOnChangeAsync,
539 TFormOnBlur,
540 TFormOnBlurAsync,
541 TFormOnSubmit,
542 TFormOnSubmitAsync,
543 TFormOnDynamic,
544 TFormOnDynamicAsync,
545 TFormOnServer,
546 TPatentSubmitMeta,
547 ExtendedApi
548>) => JSX.Element
549​
550interface FieldComponentProps<
551 TParentData,
552 TName extends DeepKeys<TParentData>,
553 TData extends DeepValue<TParentData, TName>,
554 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
555 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
556 TOnChangeAsync extends
557 | undefined
558 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
559 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
560 TOnBlurAsync extends
561 | undefined
562 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
563 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
564 TOnSubmitAsync extends
565 | undefined
566 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
567 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
568 TOnDynamicAsync extends
569 | undefined
570 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
571 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
572 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
573 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
574 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
575 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
576 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
577 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
578 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
579 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
580 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
581 TParentSubmitMeta,
582> extends CreateFieldOptions<
583 TParentData,
584 TName,
585 TData,
586 TOnMount,
587 TOnChange,
588 TOnChangeAsync,
589 TOnBlur,
590 TOnBlurAsync,
591 TOnSubmit,
592 TOnSubmitAsync,
593 TOnDynamic,
594 TOnDynamicAsync,
595 TFormOnMount,
596 TFormOnChange,
597 TFormOnChangeAsync,
598 TFormOnBlur,
599 TFormOnBlurAsync,
600 TFormOnSubmit,
601 TFormOnSubmitAsync,
602 TFormOnDynamic,
603 TFormOnDynamicAsync,
604 TFormOnServer,
605 TParentSubmitMeta
606> {
607 children: (
608 fieldApi: () => FieldApi<
609 TParentData,
610 TName,
611 TData,
612 TOnMount,
613 TOnChange,
614 TOnChangeAsync,
615 TOnBlur,
616 TOnBlurAsync,
617 TOnSubmit,
618 TOnSubmitAsync,
619 TOnDynamic,
620 TOnDynamicAsync,
621 TFormOnMount,
622 TFormOnChange,
623 TFormOnChangeAsync,
624 TFormOnBlur,
625 TFormOnBlurAsync,
626 TFormOnSubmit,
627 TFormOnSubmitAsync,
628 TFormOnDynamic,
629 TFormOnDynamicAsync,
630 TFormOnServer,
631 TParentSubmitMeta
632 >,
633 ) => JSXElement
635​
636/**
637 * A type alias representing a field component for a form lens data type.
638 */
639export type LensFieldComponent<
640 in out TLensData,
641 in out TParentSubmitMeta,
642 in out ExtendedApi = {},
643> = <
644 const TName extends DeepKeys<TLensData>,
645 TData extends DeepValue<TLensData, TName>,
646 TOnMount extends undefined | FieldValidateOrFn<unknown, string, TData>,
647 TOnChange extends undefined | FieldValidateOrFn<unknown, string, TData>,
648 TOnChangeAsync extends
649 | undefined
650 | FieldAsyncValidateOrFn<unknown, string, TData>,
651 TOnBlur extends undefined | FieldValidateOrFn<unknown, string, TData>,
652 TOnBlurAsync extends
653 | undefined
654 | FieldAsyncValidateOrFn<unknown, string, TData>,
655 TOnSubmit extends undefined | FieldValidateOrFn<unknown, string, TData>,
656 TOnSubmitAsync extends
657 | undefined
658 | FieldAsyncValidateOrFn<unknown, string, TData>,
659 TOnDynamic extends undefined | FieldValidateOrFn<unknown, string, TData>,
660 TOnDynamicAsync extends
661 | undefined
662 | FieldAsyncValidateOrFn<unknown, string, TData>,
663>({
664 children,
665 ...fieldOptions
666}: Omit<
667 FieldComponentBoundProps<
668 unknown,
669 string,
670 TData,
671 TOnMount,
672 TOnChange,
673 TOnChangeAsync,
674 TOnBlur,
675 TOnBlurAsync,
676 TOnSubmit,
677 TOnSubmitAsync,
678 TOnDynamic,
679 TOnDynamicAsync,
680 undefined | FormValidateOrFn<unknown>,
681 undefined | FormValidateOrFn<unknown>,
682 undefined | FormAsyncValidateOrFn<unknown>,
683 undefined | FormValidateOrFn<unknown>,
684 undefined | FormAsyncValidateOrFn<unknown>,
685 undefined | FormValidateOrFn<unknown>,
686 undefined | FormAsyncValidateOrFn<unknown>,
687 undefined | FormValidateOrFn<unknown>,
688 undefined | FormAsyncValidateOrFn<unknown>,
689 undefined | FormAsyncValidateOrFn<unknown>,
690 TParentSubmitMeta,
691 ExtendedApi
692 >,
693 'name' | 'validators'
694> & {
695 name: TName
696 validators?: Omit<
697 FieldValidators<
698 unknown,
699 string,
700 TData,
701 TOnMount,
702 TOnChange,
703 TOnChangeAsync,
704 TOnBlur,
705 TOnBlurAsync,
706 TOnSubmit,
707 TOnSubmitAsync,
708 TOnDynamic,
709 TOnDynamicAsync
710 >,
711 'onChangeListenTo' | 'onBlurListenTo'
712 > & {
713 /**
714 * An optional list of field names that should trigger this field's `onChange` and `onChangeAsync` events when its value changes
715 */
716 onChangeListenTo?: DeepKeys<TLensData>[]
717 /**
718 * An optional list of field names that should trigger this field's `onBlur` and `onBlurAsync` events when its value changes
719 */
720 onBlurListenTo?: DeepKeys<TLensData>[]
721 }
722}) => JSX.Element
723​
724export function Field<
725 TParentData,
726 TName extends DeepKeys<TParentData>,
727 TData extends DeepValue<TParentData, TName>,
728 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
729 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
730 TOnChangeAsync extends
731 | undefined
732 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
733 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
734 TOnBlurAsync extends
735 | undefined
736 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
737 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
738 TOnSubmitAsync extends
739 | undefined
740 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
741 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
742 TOnDynamicAsync extends
743 | undefined
744 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
745 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
746 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
747 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
748 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
749 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
750 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
751 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
752 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
753 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
754 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
755 TParentSubmitMeta,
756>(
757 props: FieldComponentProps<
758 TParentData,
759 TName,
760 TData,
761 TOnMount,
762 TOnChange,
763 TOnChangeAsync,
764 TOnBlur,
765 TOnBlurAsync,
766 TOnSubmit,
767 TOnSubmitAsync,
768 TOnDynamic,
769 TOnDynamicAsync,
770 TFormOnMount,
771 TFormOnChange,
772 TFormOnChangeAsync,
773 TFormOnBlur,
774 TFormOnBlurAsync,
775 TFormOnSubmit,
776 TFormOnSubmitAsync,
777 TFormOnDynamic,
778 TFormOnDynamicAsync,
779 TFormOnServer,
780 TParentSubmitMeta
781 >,
782) {
783 const fieldApi = createField<
784 TParentData,
785 TName,
786 TData,
787 TOnMount,
788 TOnChange,
789 TOnChangeAsync,
790 TOnBlur,
791 TOnBlurAsync,
792 TOnSubmit,
793 TOnSubmitAsync,
794 TOnDynamic,
795 TOnDynamicAsync,
796 TFormOnMount,
797 TFormOnChange,
798 TFormOnChangeAsync,
799 TFormOnBlur,
800 TFormOnBlurAsync,
801 TFormOnSubmit,
802 TFormOnSubmitAsync,
803 TFormOnDynamic,
804 TFormOnDynamicAsync,
805 TFormOnServer,
806 TParentSubmitMeta
807 >(() => {
808 const { children, ...fieldOptions } = props
809 return fieldOptions
810 })
811​
812 return <>{createComponent(() => props.children(fieldApi), {})}</>