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

useField.tsx

738 lines22.0 KB

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