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

Components.lib.tsx

166 lines4.7 KB

1import Preact, { useEffect } from 'preact/compat'
2import { InternalFormGroupApi } from '@tanstack/form-core/internals'
3import { Subscribe } from '../Subscribe.public'
4import {
5 useArrayFieldSubscription,
6 useValueFieldSubscription,
7} from './fieldSubscriptions.lib'
8import { useField } from './useField.lib'
9import type { AnyInternalFormApi } from '@tanstack/form-core/internals'
10import type { InternalPreactFormApi } from './PreactFormApi.lib'
11import type { FunctionComponent } from 'preact/compat'
12import type {
13 PreactFormFieldProps,
14 PreactFormGroupProps,
15 PreactFormSubscribeProps,
16} from './Components.public'
17​
18export function attachPreactFormComponents(
19 form: AnyInternalFormApi,
20 fieldComponents: Record<string, FunctionComponent<any>> | null,
21): InternalPreactFormApi {
22 const resultForm = form as InternalPreactFormApi
23 resultForm.Field = createFieldComponent(
24 form,
25 fieldComponents,
26 ) as InternalPreactFormApi['Field']
27 resultForm.ArrayField = createArrayFieldComponent(form, fieldComponents)
28 resultForm.Subscribe = createSubscribeComponent(form)
29 resultForm.FormGroup = createFormGroupComponent(
30 resultForm,
31 ) as InternalPreactFormApi['FormGroup']
32​
33 return resultForm
35​
36type AnyFieldComponent = FunctionComponent<
37 PreactFormFieldProps<any, any, any, any, never, any, any, any>
39​
40function createFieldComponent(
41 form: AnyInternalFormApi,
42 fieldComponents: Record<string, FunctionComponent<any>> | null,
43): AnyFieldComponent {
44 const TanStackFormField: AnyFieldComponent = (props) => {
45 const fieldApi = useField({ ...props, form }, fieldComponents)
46 const field = useValueFieldSubscription(fieldApi)
47​
48 return props.children(field)
49 }
50​
51 TanStackFormField.displayName = 'TanStackForm.Field'
52​
53 return TanStackFormField
55​
56type AnyArrayFieldComponent = FunctionComponent<any>
57​
58function createArrayFieldComponent(
59 form: AnyInternalFormApi,
60 fieldComponents: Record<string, FunctionComponent<any>> | null,
61): AnyArrayFieldComponent {
62 const TanStackFormArrayField: AnyArrayFieldComponent = (props) => {
63 const fieldApi = useField({ ...props, form }, fieldComponents)
64 const field = useArrayFieldSubscription(fieldApi)
65​
66 return props.children(field)
67 }
68​
69 TanStackFormArrayField.displayName = 'TanStackForm.ArrayField'
70​
71 return TanStackFormArrayField
73​
74type AnySubscribeComponent = FunctionComponent<
75 PreactFormSubscribeProps<any, any, any>
77​
78function createSubscribeComponent(
79 form: AnyInternalFormApi,
80): AnySubscribeComponent {
81 const TanStackFormSubscribe: AnySubscribeComponent = (props) => {
82 return <Subscribe source={form.atom} {...props} />
83 }
84​
85 TanStackFormSubscribe.displayName = 'TanStackForm.Subscribe'
86​
87 return TanStackFormSubscribe
89​
90type AnyFormGroupComponent = FunctionComponent<
91 PreactFormGroupProps<any, any, any, any, any, any>
93​
94function createFormGroupComponent(
95 form: InternalPreactFormApi,
96): AnyFormGroupComponent {
97 const TanStackFormGroup: AnyFormGroupComponent = (props) => {
98 const groupRef =
99 Preact.useRef<InternalFormGroupApi<any, any, any, any, any>>(null)
100​
101 if (!groupRef.current) {
102 groupRef.current = attachPreactFormGroupComponents(
103 new InternalFormGroupApi({ ...props, form } as never),
104 form,
105 )
106 }
107​
108 useEffect(() => groupRef.current?.update({ ...props, form }))
109​
110 Preact.useEffect(() => {
111 const group = groupRef.current!
112 group.mount()
113 return () => group._cleanup()
114 }, [])
115​
116 return props.children(groupRef.current as never)
117 }
118​
119 TanStackFormGroup.displayName = 'TanStackForm.FormGroup'
120​
121 return TanStackFormGroup
123​
124function attachPreactFormGroupComponents(
125 group: InternalFormGroupApi<any, any, any, any, any>,
126 form: InternalPreactFormApi,
127) {
128 type FormGroupComponents = InternalFormGroupApi<any, any, any, any, any> & {
129 Field: FunctionComponent<any>
130 ArrayField: FunctionComponent<any>
131 Subscribe: FunctionComponent<any>
132 }
133​
134 const resultGroup: FormGroupComponents = group as never
135​
136 resultGroup.Field = function Field(props) {
137 return (
138 <form.Field
139 {...(group._getFormFieldOptions(props, (base, overrides) => ({
140 ...base,
141 ...overrides,
142 })) as any)}
143 />
144 )
145 }
146 resultGroup.Field.displayName = 'TanStackForm.FormGroup.Field'
147​
148 resultGroup.ArrayField = function ArrayField(props) {
149 return (
150 <form.ArrayField
151 {...(group._getFormFieldOptions(props, (base, overrides) => ({
152 ...base,
153 ...overrides,
154 })) as any)}
155 />
156 )
157 }
158 resultGroup.ArrayField.displayName = 'TanStackForm.FormGroup.ArrayField'
159​
160 resultGroup.Subscribe = (props) => {
161 return <Subscribe source={group.atom} {...props} />
162 }
163 resultGroup.Subscribe.displayName = 'TanStackForm.FormGroup.Subscribe'
164​
165 return resultGroup