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

Components.lib.tsx

138 lines4.1 KB

1import React from 'react'
2​
3import { InternalFormGroupApi } from '@tanstack/form-core/internals'
4import { useField } from '../ReactForm/useField.lib'
5import { useValueFieldSubscription } from '../ReactForm/fieldSubscriptions.lib'
6import { Subscribe } from '../Subscribe.public'
7import { FieldContext, FormContext } from './contexts.lib'
8import type { FieldOptionsScope } from '@tanstack/form-core/internals'
9import type { FunctionComponent, ReactNode } from 'react'
10import type { AppFormComponent } from './ReactAppFormApi.public'
11import type {
12 ReactFormFieldProps,
13 ReactFormGroupProps,
14} from '../ReactForm/Components.public'
15import type { InternalReactFormApi } from '../ReactForm/ReactFormApi.lib'
16​
17export function createAppForm(form: InternalReactFormApi): AppFormComponent {
18 const AppForm: FunctionComponent<{
19 children: Exclude<ReactNode, Promise<any>>
20 }> = function AppFormComponent(props) {
21 // eslint-disable-next-line @eslint-react/no-context-provider
22 return <FormContext.Provider value={form as never} {...props} />
23 }
24​
25 AppForm.displayName = 'TanStackForm.AppForm'
26​
27 return AppForm
29​
30type AnyFieldComponent = FunctionComponent<
31 ReactFormFieldProps<any, any, any, any, never, any, any, any>
33​
34export function createFieldWithContext(
35 form: InternalReactFormApi,
36 scope: FieldOptionsScope,
37 useFieldSubscription = useValueFieldSubscription,
38) {
39 const TanStackFormField: AnyFieldComponent = (props) => {
40 const fieldApi = useField({ ...props, form }, scope)
41 const field = useFieldSubscription(fieldApi)
42​
43 return (
44 // eslint-disable-next-line @eslint-react/no-context-provider
45 <FieldContext.Provider value={field}>
46 {props.children(field) as never}
47 </FieldContext.Provider>
48 )
49 }
50​
51 TanStackFormField.displayName = 'TanStackForm.Field'
52​
53 return TanStackFormField
55​
56type AnyFormGroupComponent = FunctionComponent<
57 ReactFormGroupProps<any, any, any, any, any, any>
59​
60export function createFormGroupWithContext(
61 form: InternalReactFormApi,
62 groupField: FunctionComponent<any>,
63 groupArrayField: FunctionComponent<any>,
64): AnyFormGroupComponent {
65 const TanStackFormGroup: AnyFormGroupComponent = (props) => {
66 const groupRef =
67 React.useRef<InternalFormGroupApi<any, any, any, any, any>>(null)
68​
69 if (!groupRef.current) {
70 groupRef.current = attachAppFormGroupComponents(
71 new InternalFormGroupApi({ ...props, form } as never),
72 groupField,
73 groupArrayField,
74 )
75 }
76​
77 React.useEffect(() => groupRef.current?.update({ ...props, form }))
78​
79 React.useEffect(() => {
80 const group = groupRef.current!
81 group.mount()
82 return () => group._cleanup()
83 }, [])
84​
85 return props.children(groupRef.current as never)
86 }
87​
88 TanStackFormGroup.displayName = 'TanStackForm.FormGroup'
89​
90 return TanStackFormGroup
92​
93function attachAppFormGroupComponents(
94 group: InternalFormGroupApi<any, any, any, any, any>,
95 groupField: FunctionComponent<any>,
96 groupArrayField: FunctionComponent<any>,
97) {
98 type GroupWithComponents = InternalFormGroupApi<any, any, any, any, any> & {
99 Field: FunctionComponent<any>
100 ArrayField: FunctionComponent<any>
101 Subscribe: FunctionComponent<any>
102 }
103​
104 const resultGroup: GroupWithComponents = group as never
105 const GroupField = groupField
106 const GroupArrayField = groupArrayField
107​
108 resultGroup.Field = function Field(props) {
109 return (
110 <GroupField
111 {...(group._getFormFieldOptions(props, (base, overrides) => ({
112 ...base,
113 ...overrides,
114 })) as any)}
115 />
116 )
117 }
118 resultGroup.Field.displayName = 'TanStackForm.FormGroup.Field'
119​
120 resultGroup.ArrayField = function ArrayField(props) {
121 return (
122 <GroupArrayField
123 {...(group._getFormFieldOptions(props, (base, overrides) => ({
124 ...base,
125 ...overrides,
126 })) as any)}
127 />
128 )
129 }
130 resultGroup.ArrayField.displayName = 'TanStackForm.FormGroup.ArrayField'
131​
132 resultGroup.Subscribe = (props) => {
133 return <Subscribe source={group.atom} {...props} />
134 }
135 resultGroup.Subscribe.displayName = 'TanStackForm.FormGroup.Subscribe'
136​
137 return resultGroup