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

createFormHook.tsx

573 lines15.9 KB

1import {
2 createComponent,
3 createContext,
4 mergeProps,
5 splitProps,
6 useContext,
7} from 'solid-js'
8import { createFieldGroup } from './createFieldGroup'
9import { createForm } from './createForm'
10import type {
11 AnyFieldApi,
12 AnyFormApi,
13 BaseFormOptions,
14 DeepKeysOfType,
15 FieldApi,
16 FieldsMap,
17 FormAsyncValidateOrFn,
18 FormOptions,
19 FormValidateOrFn,
20} from '@tanstack/form-core'
21import type {
22 Accessor,
23 Component,
24 Context,
25 JSXElement,
26 ParentProps,
27} from 'solid-js'
28import type { FieldComponent } from './createField'
29import type { AppFieldExtendedSolidFieldGroupApi } from './createFieldGroup'
30import type { SolidFormExtendedApi } from './createForm'
31​
32/**
33 * TypeScript inferencing is weird.
34 *
35 * If you have:
36 *
37 * @example
38 *
39 * interface Args<T> {
40 * arg?: T
41 * }
42 *
43 * function test<T>(arg?: Partial<Args<T>>): T {
44 * return 0 as any;
45 * }
46 *
47 * const a = test({});
48 *
49 * Then `T` will default to `unknown`.
50 *
51 * However, if we change `test` to be:
52 *
53 * @example
54 *
55 * function test<T extends undefined>(arg?: Partial<Args<T>>): T;
56 *
57 * Then `T` becomes `undefined`.
58 *
59 * Here, we are checking if the passed type `T` extends `DefaultT` and **only**
60 * `DefaultT`, as if that's the case we assume that inferencing has not occurred.
61 */
62type UnwrapOrAny<T> = [unknown] extends [T] ? any : T
63type UnwrapDefaultOrAny<DefaultT, T> = [DefaultT] extends [T]
64 ? [T] extends [DefaultT]
65 ? any
66 : T
67 : T
68​
69export function createFormHookContexts() {
70 // We should never hit the `null` case here
71 const fieldContext = createContext<Accessor<AnyFieldApi>>(
72 null as unknown as Accessor<AnyFieldApi>,
73 )
74​
75 function useFieldContext<TData>() {
76 const field = useContext(fieldContext)
77​
78 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
79 if (!field) {
80 throw new Error(
81 '`fieldContext` only works when within a `fieldComponent` passed to `createFormHook`',
82 )
83 }
84​
85 return field as Accessor<
86 FieldApi<
87 any,
88 string,
89 TData,
90 any,
91 any,
92 any,
93 any,
94 any,
95 any,
96 any,
97 any,
98 any,
99 any,
100 any,
101 any,
102 any,
103 any,
104 any,
105 any,
106 any,
107 any,
108 any,
109 any
110 >
111 >
112 }
113​
114 // We should never hit the `null` case here
115 const formContext = createContext<AnyFormApi>(null as unknown as AnyFormApi)
116​
117 function useFormContext() {
118 const form = useContext(formContext)
119​
120 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
121 if (!form) {
122 throw new Error(
123 '`formContext` only works when within a `formComponent` passed to `createFormHook`',
124 )
125 }
126​
127 return form as SolidFormExtendedApi<
128 // If you need access to the form data, you need to use `withForm` instead
129 Record<string, never>,
130 any,
131 any,
132 any,
133 any,
134 any,
135 any,
136 any,
137 any,
138 any,
139 any,
140 any
141 >
142 }
143​
144 return { fieldContext, useFieldContext, useFormContext, formContext }
146​
147interface CreateFormHookProps<
148 TFieldComponents extends Record<string, Component<any>>,
149 TFormComponents extends Record<string, Component<any>>,
150> {
151 fieldComponents: TFieldComponents
152 fieldContext: Context<Accessor<AnyFieldApi>>
153 formComponents: TFormComponents
154 formContext: Context<AnyFormApi>
156/**
157 * @private
158 */
159export type AppFieldExtendedSolidFormApi<
160 TFormData,
161 TOnMount extends undefined | FormValidateOrFn<TFormData>,
162 TOnChange extends undefined | FormValidateOrFn<TFormData>,
163 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
164 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
165 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
166 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
167 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
168 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
169 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
170 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
171 TSubmitMeta,
172 TFieldComponents extends Record<string, Component<any>>,
173 TFormComponents extends Record<string, Component<any>>,
174> = SolidFormExtendedApi<
175 TFormData,
176 TOnMount,
177 TOnChange,
178 TOnChangeAsync,
179 TOnBlur,
180 TOnBlurAsync,
181 TOnSubmit,
182 TOnSubmitAsync,
183 TOnDynamic,
184 TOnDynamicAsync,
185 TOnServer,
186 TSubmitMeta
187> &
188 NoInfer<TFormComponents> & {
189 AppField: FieldComponent<
190 TFormData,
191 TOnMount,
192 TOnChange,
193 TOnChangeAsync,
194 TOnBlur,
195 TOnBlurAsync,
196 TOnSubmit,
197 TOnSubmitAsync,
198 TOnDynamic,
199 TOnDynamicAsync,
200 TOnServer,
201 TSubmitMeta,
202 NoInfer<TFieldComponents>
203 >
204 AppForm: Component<ParentProps>
205 }
206​
207export interface WithFormProps<
208 TFormData,
209 TOnMount extends undefined | FormValidateOrFn<TFormData>,
210 TOnChange extends undefined | FormValidateOrFn<TFormData>,
211 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
212 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
213 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
214 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
215 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
216 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
217 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
218 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
219 TSubmitMeta,
220 TFieldComponents extends Record<string, Component<any>>,
221 TFormComponents extends Record<string, Component<any>>,
222 TRenderProps extends Record<string, unknown> = Record<string, never>,
223> extends FormOptions<
224 TFormData,
225 TOnMount,
226 TOnChange,
227 TOnChangeAsync,
228 TOnBlur,
229 TOnBlurAsync,
230 TOnSubmit,
231 TOnSubmitAsync,
232 TOnDynamic,
233 TOnDynamicAsync,
234 TOnServer,
235 TSubmitMeta
236> {
237 // Optional, but adds props to the `render` function outside of `form`
238 props?: TRenderProps
239 render: (
240 props: ParentProps<
241 NoInfer<TRenderProps> & {
242 form: AppFieldExtendedSolidFormApi<
243 TFormData,
244 TOnMount,
245 TOnChange,
246 TOnChangeAsync,
247 TOnBlur,
248 TOnBlurAsync,
249 TOnSubmit,
250 TOnSubmitAsync,
251 TOnDynamic,
252 TOnDynamicAsync,
253 TOnServer,
254 TSubmitMeta,
255 TFieldComponents,
256 TFormComponents
257 >
258 }
259 >,
260 ) => JSXElement
262​
263export interface WithFieldGroupProps<
264 TFieldGroupData,
265 TFieldComponents extends Record<string, Component<any>>,
266 TFormComponents extends Record<string, Component<any>>,
267 TSubmitMeta,
268 TRenderProps extends Record<string, unknown> = Record<string, never>,
269> extends BaseFormOptions<TFieldGroupData, TSubmitMeta> {
270 // Optional, but adds props to the `render` function outside of `form`
271 props?: TRenderProps
272 render: (
273 props: ParentProps<
274 NoInfer<TRenderProps> & {
275 group: AppFieldExtendedSolidFieldGroupApi<
276 unknown,
277 TFieldGroupData,
278 string | FieldsMap<unknown, TFieldGroupData>,
279 undefined | FormValidateOrFn<unknown>,
280 undefined | FormValidateOrFn<unknown>,
281 undefined | FormAsyncValidateOrFn<unknown>,
282 undefined | FormValidateOrFn<unknown>,
283 undefined | FormAsyncValidateOrFn<unknown>,
284 undefined | FormValidateOrFn<unknown>,
285 undefined | FormAsyncValidateOrFn<unknown>,
286 undefined | FormValidateOrFn<unknown>,
287 undefined | FormAsyncValidateOrFn<unknown>,
288 undefined | FormAsyncValidateOrFn<unknown>,
289 // this types it as 'never' in the render prop. It should prevent any
290 // untyped meta passed to the handleSubmit by accident.
291 unknown extends TSubmitMeta ? never : TSubmitMeta,
292 TFieldComponents,
293 TFormComponents
294 >
295 }
296 >,
297 ) => JSXElement
299​
300export function createFormHook<
301 const TComponents extends Record<string, Component<any>>,
302 const TFormComponents extends Record<string, Component<any>>,
303>(opts: CreateFormHookProps<TComponents, TFormComponents>) {
304 function useAppForm<
305 TFormData,
306 TOnMount extends undefined | FormValidateOrFn<TFormData>,
307 TOnChange extends undefined | FormValidateOrFn<TFormData>,
308 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
309 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
310 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
311 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
312 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
313 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
314 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
315 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
316 TSubmitMeta,
317 >(
318 props: Accessor<
319 FormOptions<
320 TFormData,
321 TOnMount,
322 TOnChange,
323 TOnChangeAsync,
324 TOnBlur,
325 TOnBlurAsync,
326 TOnSubmit,
327 TOnSubmitAsync,
328 TOnDynamic,
329 TOnDynamicAsync,
330 TOnServer,
331 TSubmitMeta
332 >
333 >,
334 ): AppFieldExtendedSolidFormApi<
335 TFormData,
336 TOnMount,
337 TOnChange,
338 TOnChangeAsync,
339 TOnBlur,
340 TOnBlurAsync,
341 TOnSubmit,
342 TOnSubmitAsync,
343 TOnDynamic,
344 TOnDynamicAsync,
345 TOnServer,
346 TSubmitMeta,
347 TComponents,
348 TFormComponents
349 > {
350 const form = createForm(props)
351​
352 const AppForm = ((formProps) => {
353 return (
354 <opts.formContext.Provider value={form}>
355 {formProps.children}
356 </opts.formContext.Provider>
357 )
358 }) as Component<ParentProps>
359​
360 const AppField = ((_props) => {
361 const [childProps, fieldProps] = splitProps(_props, ['children'])
362 return (
363 <form.Field {...fieldProps}>
364 {(field) => (
365 <opts.fieldContext.Provider value={field}>
366 {createComponent(
367 () =>
368 childProps.children(
369 Object.assign(field, opts.fieldComponents),
370 ),
371 {},
372 )}
373 </opts.fieldContext.Provider>
374 )}
375 </form.Field>
376 )
377 }) as FieldComponent<
378 TFormData,
379 TOnMount,
380 TOnChange,
381 TOnChangeAsync,
382 TOnBlur,
383 TOnBlurAsync,
384 TOnSubmit,
385 TOnSubmitAsync,
386 TOnDynamic,
387 TOnDynamicAsync,
388 TOnServer,
389 TSubmitMeta,
390 TComponents
391 >
392​
393 const extendedForm: AppFieldExtendedSolidFormApi<
394 TFormData,
395 TOnMount,
396 TOnChange,
397 TOnChangeAsync,
398 TOnBlur,
399 TOnBlurAsync,
400 TOnSubmit,
401 TOnSubmitAsync,
402 TOnDynamic,
403 TOnDynamicAsync,
404 TOnServer,
405 TSubmitMeta,
406 TComponents,
407 TFormComponents
408 > = form as never
409 extendedForm.AppField = AppField
410 extendedForm.AppForm = AppForm
411 for (const [key, value] of Object.entries(opts.formComponents)) {
412 // Since it's a generic I need to cast it to an object
413 ;(extendedForm as Record<string, any>)[key] = value
414 }
415​
416 return extendedForm
417 }
418​
419 function withForm<
420 TFormData,
421 TOnMount extends undefined | FormValidateOrFn<TFormData>,
422 TOnChange extends undefined | FormValidateOrFn<TFormData>,
423 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
424 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
425 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
426 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
427 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
428 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
429 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
430 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
431 TSubmitMeta,
432 TRenderProps extends Record<string, unknown> = {},
433 >({
434 render,
435 props,
436 }: WithFormProps<
437 TFormData,
438 TOnMount,
439 TOnChange,
440 TOnChangeAsync,
441 TOnBlur,
442 TOnBlurAsync,
443 TOnSubmit,
444 TOnSubmitAsync,
445 TOnDynamic,
446 TOnDynamicAsync,
447 TOnServer,
448 TSubmitMeta,
449 TComponents,
450 TFormComponents,
451 TRenderProps
452 >): WithFormProps<
453 UnwrapOrAny<TFormData>,
454 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnMount>,
455 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnChange>,
456 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnChangeAsync>,
457 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnBlur>,
458 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnBlurAsync>,
459 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnSubmit>,
460 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnSubmitAsync>,
461 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnDynamic>,
462 UnwrapDefaultOrAny<
463 undefined | FormValidateOrFn<TFormData>,
464 TOnDynamicAsync
465 >,
466 UnwrapDefaultOrAny<undefined | FormValidateOrFn<TFormData>, TOnServer>,
467 UnwrapOrAny<TSubmitMeta>,
468 UnwrapOrAny<TComponents>,
469 UnwrapOrAny<TFormComponents>,
470 UnwrapOrAny<TRenderProps>
471 >['render'] {
472 return (innerProps) =>
473 createComponent(
474 render as Component<any>,
475 mergeProps(props ?? {}, innerProps),
476 )
477 }
478​
479 function withFieldGroup<
480 TFieldGroupData,
481 TSubmitMeta,
482 TRenderProps extends Record<string, unknown> = {},
483 >({
484 render,
485 props,
486 defaultValues,
487 }: WithFieldGroupProps<
488 TFieldGroupData,
489 TComponents,
490 TFormComponents,
491 TSubmitMeta,
492 TRenderProps
493 >): <
494 TFormData,
495 TFields extends
496 | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>
497 | FieldsMap<TFormData, TFieldGroupData>,
498 TOnMount extends undefined | FormValidateOrFn<TFormData>,
499 TOnChange extends undefined | FormValidateOrFn<TFormData>,
500 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
501 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
502 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
503 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
504 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
505 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
506 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
507 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
508 TFormSubmitMeta,
509 >(
510 params: ParentProps<
511 NoInfer<TRenderProps> & {
512 form:
513 | AppFieldExtendedSolidFormApi<
514 TFormData,
515 TOnMount,
516 TOnChange,
517 TOnChangeAsync,
518 TOnBlur,
519 TOnBlurAsync,
520 TOnSubmit,
521 TOnSubmitAsync,
522 TOnDynamic,
523 TOnDynamicAsync,
524 TOnServer,
525 unknown extends TSubmitMeta ? TFormSubmitMeta : TSubmitMeta,
526 TComponents,
527 TFormComponents
528 >
529 | AppFieldExtendedSolidFieldGroupApi<
530 // Since this only occurs if you nest it within other field groups, it can be more
531 // lenient with the types.
532 unknown,
533 TFormData,
534 string | FieldsMap<unknown, TFormData>,
535 any,
536 any,
537 any,
538 any,
539 any,
540 any,
541 any,
542 any,
543 any,
544 any,
545 unknown extends TSubmitMeta ? TFormSubmitMeta : TSubmitMeta,
546 TComponents,
547 TFormComponents
548 >
549 fields: TFields
550 }
551 >,
552 ) => JSXElement {
553 return function Render(innerProps) {
554 const fieldGroupProps = {
555 form: innerProps.form,
556 fields: innerProps.fields,
557 defaultValues,
558 formComponents: opts.formComponents,
559 }
560 const fieldGroupApi = createFieldGroup(() => fieldGroupProps)
561 return createComponent(
562 render as Component<any>,
563 mergeProps(props ?? {}, innerProps, { group: fieldGroupApi as any }),
564 )
565 }
566 }
567​
568 return {
569 useAppForm,
570 withForm,
571 withFieldGroup,
572 }