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

withFields.lib.ts

109 lines2.9 KB

1import React from 'react'
2import {
3 InternalFieldGroupApi,
4 defineFieldGroupFieldsRuntime,
5 fieldGroupHelperRuntime,
6} from '@tanstack/form-core/internals'
7import type { InternalFieldGroupBindings } from '@tanstack/form-core/internals'
8import type { FunctionComponent } from 'react'
9import type { AnyFieldGroupApi } from './FieldGroupApi.public'
10​
11function attachReactFieldGroupComponents(
12 group: InternalFieldGroupApi,
13 form: any,
14): AnyFieldGroupApi {
15 const Field: FunctionComponent<any> = (props) => {
16 const FormField = form.Field
17 return React.createElement(
18 FormField as FunctionComponent<any>,
19 group._getFormFieldOptions(props, (base, overrides) => ({
20 ...base,
21 ...overrides,
22 })),
23 )
24 }
25 Field.displayName = 'TanStackForm.FieldGroup.Field'
26​
27 const ArrayField: FunctionComponent<any> = (props) => {
28 const FormArrayField = form.ArrayField
29 return React.createElement(
30 FormArrayField as FunctionComponent<any>,
31 group._getFormFieldOptions(props, (base, overrides) => ({
32 ...base,
33 ...overrides,
34 })),
35 )
36 }
37 ArrayField.displayName = 'TanStackForm.FieldGroup.ArrayField'
38​
39 const Subscribe: FunctionComponent<any> = (props) => {
40 const FormSubscribe = form.Subscribe
41 return React.createElement(FormSubscribe as FunctionComponent<any>, props)
42 }
43 Subscribe.displayName = 'TanStackForm.FieldGroup.Subscribe'
44​
45 return Object.assign(group, {
46 Field,
47 ArrayField,
48 Subscribe,
49 }) as never
51​
52export function defineFieldGroupRuntime<
53 TFields extends Record<string, unknown>,
54>(defineFieldGroupFn: (helperRuntime: any) => TFields) {
55 const fields = defineFieldGroupFieldsRuntime(
56 defineFieldGroupFn(fieldGroupHelperRuntime),
57 )
58​
59 return {
60 fields,
61 bindComponent: (
62 Component: (props: any) => unknown,
63 fieldsPropName: string,
64 ) => withFieldsRuntime(fields, Component, fieldsPropName),
65 }
67​
68function withFieldsRuntime(
69 fields: Record<string, unknown>,
70 Component: (props: any) => unknown,
71 fieldsPropName: string,
72) {
73 const fieldNames = Object.keys(fields)
74​
75 const FieldGroupComponent = (props: any) => {
76 const { form, ...restProps } = props
77 const bindingsRef = React.useRef<InternalFieldGroupBindings | undefined>(
78 props[fieldsPropName],
79 )
80​
81 if (!form) {
82 throw new Error('TanStack Form: Field groups must receive a `form` prop.')
83 }
84​
85 bindingsRef.current = props[fieldsPropName]
86​
87 const fieldGroupApi = React.useMemo(
88 () =>
89 attachReactFieldGroupComponents(
90 new InternalFieldGroupApi({
91 form,
92 fieldNames,
93 getBindings: () => bindingsRef.current,
94 }),
95 form,
96 ),
97 [form],
98 )
99​
100 return Component({
101 ...restProps,
102 [fieldsPropName]: fieldGroupApi,
103 })
104 }
105​
106 FieldGroupComponent.displayName = 'TanStackForm.FieldGroup'
107​
108 return FieldGroupComponent