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

useFormGroup.tsx

741 lines20.9 KB

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