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