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

useField.tsx

730 lines21.6 KB

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