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

createForm.tsx

61 lines2.1 KB

1import type { FormOptions, FormState, Validator } from '@tanstack/form-core'
2import { FormApi, functionalUpdate } from '@tanstack/form-core'
3import { createComputed, onMount, type JSXElement } from 'solid-js'
4import { useStore } from '@tanstack/solid-store'
5import {
6 Field,
7 createField,
8 type CreateField,
9 type FieldComponent,
10} from './createField'
11import { formContext } from './formContext'
12​
13type NoInfer<T> = [T][T extends any ? 0 : never]
14​
15declare module '@tanstack/form-core' {
16 // eslint-disable-next-line no-shadow
17 interface FormApi<TFormData, TFormValidator> {
18 Provider: (props: { children: any }) => JSXElement
19 Field: FieldComponent<TFormData, TFormValidator>
20 createField: CreateField<TFormData>
21 useStore: <TSelected = NoInfer<FormState<TFormData>>>(
22 selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,
23 ) => () => TSelected
24 Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {
25 selector?: (state: NoInfer<FormState<TFormData>>) => TSelected
26 children: ((state: () => NoInfer<TSelected>) => JSXElement) | JSXElement
27 }) => JSXElement
28 }
30​
31export function createForm<
32 TParentData,
33 TFormValidator extends
34 | Validator<TParentData, unknown>
35 | undefined = undefined,
36>(
37 opts?: () => FormOptions<TParentData, TFormValidator>,
38): FormApi<TParentData, TFormValidator> {
39 const options = opts?.()
40 const formApi = new FormApi<TParentData, TFormValidator>(options)
41​
42 formApi.Provider = function Provider(props) {
43 onMount(formApi.mount)
44 return (
45 <formContext.Provider {...props} value={{ formApi: formApi as never }} />
46 )
47 }
48 formApi.Field = Field as any
49 formApi.createField = createField as CreateField<TParentData>
50 formApi.useStore = (selector) => useStore(formApi.store, selector)
51 formApi.Subscribe = (props) =>
52 functionalUpdate(props.children, useStore(formApi.store, props.selector))
53​
54 /**
55 * formApi.update should not have any side effects. Think of it like a `useRef`
56 * that we need to keep updated every render with the most up-to-date information.
57 */
58 createComputed(() => formApi.update(opts?.()))
59​
60 return formApi