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