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

createFormHook.tsx

332 lines8.5 KB

1import { createContext, useContext, useMemo } from 'react'
2import { useForm } from './useForm'
3import type {
4 AnyFieldApi,
5 AnyFormApi,
6 FieldApi,
7 FormApi,
8 FormAsyncValidateOrFn,
9 FormOptions,
10 FormValidateOrFn,
11} from '@tanstack/form-core'
12import type { ComponentType, Context, JSX, PropsWithChildren } from 'react'
13import type { FieldComponent } from './useField'
14import type { ReactFormExtendedApi } from './useForm'
15​
16export function createFormHookContexts() {
17 // We should never hit the `null` case here
18 const fieldContext = createContext<AnyFieldApi>(null as never)
19​
20 function useFieldContext<TData>() {
21 const field = useContext(fieldContext)
22​
23 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
24 if (!field) {
25 throw new Error(
26 '`fieldContext` only works when within a `fieldComponent` passed to `createFormHook`',
27 )
28 }
29​
30 return field as FieldApi<
31 any,
32 string,
33 TData,
34 any,
35 any,
36 any,
37 any,
38 any,
39 any,
40 any,
41 any,
42 any,
43 any,
44 any,
45 any,
46 any,
47 any,
48 any,
49 any
50 >
51 }
52​
53 // We should never hit the `null` case here
54 const formContext = createContext<AnyFormApi>(null as never)
55​
56 function useFormContext() {
57 const form = useContext(formContext)
58​
59 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
60 if (!form) {
61 throw new Error(
62 '`formContext` only works when within a `formComponent` passed to `createFormHook`',
63 )
64 }
65​
66 return form as ReactFormExtendedApi<
67 // If you need access to the form data, you need to use `withForm` instead
68 Record<string, never>,
69 any,
70 any,
71 any,
72 any,
73 any,
74 any,
75 any,
76 any,
77 any
78 >
79 }
80​
81 return { fieldContext, useFieldContext, useFormContext, formContext }
83​
84interface CreateFormHookProps<
85 TFieldComponents extends Record<string, ComponentType<any>>,
86 TFormComponents extends Record<string, ComponentType<any>>,
87> {
88 fieldComponents: TFieldComponents
89 fieldContext: Context<AnyFieldApi>
90 formComponents: TFormComponents
91 formContext: Context<AnyFormApi>
93​
94type AppFieldExtendedReactFormApi<
95 TFormData,
96 TOnMount extends undefined | FormValidateOrFn<TFormData>,
97 TOnChange extends undefined | FormValidateOrFn<TFormData>,
98 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
99 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
100 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
101 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
102 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
103 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
104 TSubmitMeta,
105 TFieldComponents extends Record<string, ComponentType<any>>,
106 TFormComponents extends Record<string, ComponentType<any>>,
107> = ReactFormExtendedApi<
108 TFormData,
109 TOnMount,
110 TOnChange,
111 TOnChangeAsync,
112 TOnBlur,
113 TOnBlurAsync,
114 TOnSubmit,
115 TOnSubmitAsync,
116 TOnServer,
117 TSubmitMeta
118> &
119 NoInfer<TFormComponents> & {
120 AppField: FieldComponent<
121 TFormData,
122 TOnMount,
123 TOnChange,
124 TOnChangeAsync,
125 TOnBlur,
126 TOnBlurAsync,
127 TOnSubmit,
128 TOnSubmitAsync,
129 TOnServer,
130 TSubmitMeta,
131 NoInfer<TFieldComponents>
132 >
133 AppForm: ComponentType<PropsWithChildren>
134 }
135​
136interface WithFormProps<
137 TFormData,
138 TOnMount extends undefined | FormValidateOrFn<TFormData>,
139 TOnChange extends undefined | FormValidateOrFn<TFormData>,
140 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
141 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
142 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
143 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
144 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
145 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
146 TSubmitMeta,
147 TFieldComponents extends Record<string, ComponentType<any>>,
148 TFormComponents extends Record<string, ComponentType<any>>,
149 TRenderProps extends Record<string, unknown> = Record<string, never>,
150> extends FormOptions<
151 TFormData,
152 TOnMount,
153 TOnChange,
154 TOnChangeAsync,
155 TOnBlur,
156 TOnBlurAsync,
157 TOnSubmit,
158 TOnSubmitAsync,
159 TOnServer,
160 TSubmitMeta
161 > {
162 // Optional, but adds props to the `render` function outside of `form`
163 props?: TRenderProps
164 render: (
165 props: PropsWithChildren<
166 NoInfer<TRenderProps> & {
167 form: AppFieldExtendedReactFormApi<
168 TFormData,
169 TOnMount,
170 TOnChange,
171 TOnChangeAsync,
172 TOnBlur,
173 TOnBlurAsync,
174 TOnSubmit,
175 TOnSubmitAsync,
176 TOnServer,
177 TSubmitMeta,
178 TFieldComponents,
179 TFormComponents
180 >
181 }
182 >,
183 ) => JSX.Element
185​
186export function createFormHook<
187 const TComponents extends Record<string, ComponentType<any>>,
188 const TFormComponents extends Record<string, ComponentType<any>>,
189>({
190 fieldComponents,
191 fieldContext,
192 formContext,
193 formComponents,
194}: CreateFormHookProps<TComponents, TFormComponents>) {
195 function useAppForm<
196 TFormData,
197 TOnMount extends undefined | FormValidateOrFn<TFormData>,
198 TOnChange extends undefined | FormValidateOrFn<TFormData>,
199 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
200 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
201 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
202 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
203 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
204 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
205 TSubmitMeta,
206 >(
207 props: FormOptions<
208 TFormData,
209 TOnMount,
210 TOnChange,
211 TOnChangeAsync,
212 TOnBlur,
213 TOnBlurAsync,
214 TOnSubmit,
215 TOnSubmitAsync,
216 TOnServer,
217 TSubmitMeta
218 >,
219 ): AppFieldExtendedReactFormApi<
220 TFormData,
221 TOnMount,
222 TOnChange,
223 TOnChangeAsync,
224 TOnBlur,
225 TOnBlurAsync,
226 TOnSubmit,
227 TOnSubmitAsync,
228 TOnServer,
229 TSubmitMeta,
230 TComponents,
231 TFormComponents
232 > {
233 const form = useForm(props)
234​
235 const AppForm = useMemo(() => {
236 return (({ children }) => {
237 return (
238 <formContext.Provider value={form}>{children}</formContext.Provider>
239 )
240 }) as ComponentType<PropsWithChildren>
241 }, [form])
242​
243 const AppField = useMemo(() => {
244 return (({ children, ...props }) => {
245 return (
246 <form.Field {...props}>
247 {(field) => (
248 // eslint-disable-next-line @eslint-react/no-context-provider
249 <fieldContext.Provider value={field}>
250 {children(Object.assign(field, fieldComponents))}
251 </fieldContext.Provider>
252 )}
253 </form.Field>
254 )
255 }) as FieldComponent<
256 TFormData,
257 TOnMount,
258 TOnChange,
259 TOnChangeAsync,
260 TOnBlur,
261 TOnBlurAsync,
262 TOnSubmit,
263 TOnSubmitAsync,
264 TOnServer,
265 TSubmitMeta,
266 TComponents
267 >
268 }, [form])
269​
270 const extendedForm = useMemo(() => {
271 return Object.assign(form, {
272 AppField,
273 AppForm,
274 ...formComponents,
275 })
276 }, [form, AppField, AppForm])
277​
278 return extendedForm
279 }
280​
281 function withForm<
282 TFormData,
283 TOnMount extends undefined | FormValidateOrFn<TFormData>,
284 TOnChange extends undefined | FormValidateOrFn<TFormData>,
285 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
286 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
287 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
288 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
289 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
290 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
291 TSubmitMeta,
292 TRenderProps extends Record<string, unknown> = Record<string, never>,
293 >({
294 render,
295 props,
296 }: WithFormProps<
297 TFormData,
298 TOnMount,
299 TOnChange,
300 TOnChangeAsync,
301 TOnBlur,
302 TOnBlurAsync,
303 TOnSubmit,
304 TOnSubmitAsync,
305 TOnServer,
306 TSubmitMeta,
307 TComponents,
308 TFormComponents,
309 TRenderProps
310 >): WithFormProps<
311 TFormData,
312 TOnMount,
313 TOnChange,
314 TOnChangeAsync,
315 TOnBlur,
316 TOnBlurAsync,
317 TOnSubmit,
318 TOnSubmitAsync,
319 TOnServer,
320 TSubmitMeta,
321 TComponents,
322 TFormComponents,
323 TRenderProps
324 >['render'] {
325 return (innerProps) => render({ ...props, ...innerProps })
326 }
327​
328 return {
329 useAppForm,
330 withForm,
331 }