Open History to see the last commit
1'use client'
2β
3import { useState } from 'react'
4import { useStore } from '@tanstack/react-store'
5import { FieldGroupApi, functionalUpdate } from '@tanstack/form-core'
6import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
7import type {
8 AnyFieldGroupApi,
9 DeepKeysOfType,
10 FieldGroupState,
11 FieldsMap,
12 FormAsyncValidateOrFn,
13 FormValidateOrFn,
14} from '@tanstack/form-core'
15import type { AppFieldExtendedReactFormApi } from './createFormHook'
16import type {
17 ComponentType,
18 FunctionComponent,
19 PropsWithChildren,
20 ReactNode,
21} from 'react'
22import type { LensFieldComponent } from './useField'
23β
24function LocalSubscribe({
25 lens,
26 selector = (state) => state,
27 children,
28}: PropsWithChildren<{
29 lens: AnyFieldGroupApi
30 selector?: (state: FieldGroupState<any>) => FieldGroupState<any>
31}>): ReturnType<FunctionComponent> {
32 const data = useStore(lens.store, selector)
33β
34 return <>{functionalUpdate(children, data)}</>
35}
36β
37/**
38 * @private
39 */
40export type AppFieldExtendedReactFieldGroupApi<
41 TFormData,
42 TFieldGroupData,
43 TFields extends
44 | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
45 | FieldsMap<TFormData, TFieldGroupData>,
46 TOnMount extends undefined | FormValidateOrFn<TFormData>,
47 TOnChange extends undefined | FormValidateOrFn<TFormData>,
48 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
49 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
50 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
51 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
52 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
53 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
54 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
55 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
56 TSubmitMeta,
57 TFieldComponents extends Record<string, ComponentType<any>>,
58 TFormComponents extends Record<string, ComponentType<any>>,
59> = FieldGroupApi<
60 TFormData,
61 TFieldGroupData,
62 TFields,
63 TOnMount,
64 TOnChange,
65 TOnChangeAsync,
66 TOnBlur,
67 TOnBlurAsync,
68 TOnSubmit,
69 TOnSubmitAsync,
70 TOnDynamic,
71 TOnDynamicAsync,
72 TOnServer,
73 TSubmitMeta
74> &
75 NoInfer<TFormComponents> & {
76 AppField: LensFieldComponent<
77 TFieldGroupData,
78 TSubmitMeta,
79 NoInfer<TFieldComponents>
80 >
81 AppForm: ComponentType<PropsWithChildren<{}>>
82 /**
83 * A React component to render form fields. With this, you can render and manage individual form fields.
84 */
85 Field: LensFieldComponent<TFieldGroupData, TSubmitMeta>
86β
87 /**
88 * A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates.
89 */
90 Subscribe: <TSelected = NoInfer<FieldGroupState<TFieldGroupData>>>(props: {
91 selector?: (state: NoInfer<FieldGroupState<TFieldGroupData>>) => TSelected
92 children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode
93 }) => ReturnType<FunctionComponent>
94 }
95β
96export function useFieldGroup<
97 TFormData,
98 TFieldGroupData,
99 TFields extends
100 | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
101 | FieldsMap<TFormData, TFieldGroupData>,
102 TOnMount extends undefined | FormValidateOrFn<TFormData>,
103 TOnChange extends undefined | FormValidateOrFn<TFormData>,
104 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
105 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
106 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
107 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
108 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
109 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
110 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
111 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
112 TComponents extends Record<string, ComponentType<any>>,
113 TFormComponents extends Record<string, ComponentType<any>>,
114 TSubmitMeta = never,
115>(opts: {
116 form:
117 | AppFieldExtendedReactFormApi<
118 TFormData,
119 TOnMount,
120 TOnChange,
121 TOnChangeAsync,
122 TOnBlur,
123 TOnBlurAsync,
124 TOnSubmit,
125 TOnSubmitAsync,
126 TOnDynamic,
127 TOnDynamicAsync,
128 TOnServer,
129 TSubmitMeta,
130 TComponents,
131 TFormComponents
132 >
133 | AppFieldExtendedReactFieldGroupApi<
134 // Since this only occurs if you nest it within other form lenses, it can be more
135 // lenient with the types.
136 unknown,
137 TFormData,
138 string | FieldsMap<unknown, TFormData>,
139 any,
140 any,
141 any,
142 any,
143 any,
144 any,
145 any,
146 any,
147 any,
148 any,
149 TSubmitMeta,
150 TComponents,
151 TFormComponents
152 >
153 fields: TFields
154 defaultValues?: TFieldGroupData
155 onSubmitMeta?: TSubmitMeta
156 formComponents: TFormComponents
157}): AppFieldExtendedReactFieldGroupApi<
158 TFormData,
159 TFieldGroupData,
160 TFields,
161 TOnMount,
162 TOnChange,
163 TOnChangeAsync,
164 TOnBlur,
165 TOnBlurAsync,
166 TOnSubmit,
167 TOnSubmitAsync,
168 TOnDynamic,
169 TOnDynamicAsync,
170 TOnServer,
171 TSubmitMeta,
172 TComponents,
173 TFormComponents
174> {
175 const [formLensApi] = useState(() => {
176 const api = new FieldGroupApi(opts)
177 const form =
178 opts.form instanceof FieldGroupApi
179 ? (opts.form.form as AppFieldExtendedReactFormApi<
180 TFormData,
181 TOnMount,
182 TOnChange,
183 TOnChangeAsync,
184 TOnBlur,
185 TOnBlurAsync,
186 TOnSubmit,
187 TOnSubmitAsync,
188 TOnDynamic,
189 TOnDynamicAsync,
190 TOnServer,
191 TSubmitMeta,
192 TComponents,
193 TFormComponents
194 >)
195 : opts.form
196β
197 const extendedApi: AppFieldExtendedReactFieldGroupApi<
198 TFormData,
199 TFieldGroupData,
200 TFields,
201 TOnMount,
202 TOnChange,
203 TOnChangeAsync,
204 TOnBlur,
205 TOnBlurAsync,
206 TOnSubmit,
207 TOnSubmitAsync,
208 TOnDynamic,
209 TOnDynamicAsync,
210 TOnServer,
211 TSubmitMeta,
212 TComponents,
213 TFormComponents
214 > = api as never
215β
216 extendedApi.AppForm = function AppForm(appFormProps) {
217 return <form.AppForm {...appFormProps} />
218 }
219β
220 extendedApi.AppField = function AppField(props) {
221 return (
222 <form.AppField {...(formLensApi.getFormFieldOptions(props) as any)} />
223 )
224 }
225β
226 extendedApi.Field = function Field(props) {
227 return <form.Field {...(formLensApi.getFormFieldOptions(props) as any)} />
228 }
229β
230 extendedApi.Subscribe = function Subscribe(props: any) {
231 return (
232 <LocalSubscribe
233 lens={formLensApi}
234 selector={props.selector}
235 children={props.children}
236 />
237 )
238 }
239β
240 return Object.assign(extendedApi, {
241 ...opts.formComponents,
242 }) as AppFieldExtendedReactFieldGroupApi<
243 TFormData,
244 TFieldGroupData,
245 TFields,
246 TOnMount,
247 TOnChange,
248 TOnChangeAsync,
249 TOnBlur,
250 TOnBlurAsync,
251 TOnSubmit,
252 TOnSubmitAsync,
253 TOnDynamic,
254 TOnDynamicAsync,
255 TOnServer,
256 TSubmitMeta,
257 TComponents,
258 TFormComponents
259 >
260 })
261β
262 useIsomorphicLayoutEffect(formLensApi.mount, [formLensApi])
263β
264 return formLensApi
265}