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

createForm.tsx

185 lines4.8 KB

1import { FormApi, functionalUpdate } from '@tanstack/form-core'
2import { createComputed, onMount } from 'solid-js'
3import { useStore } from '@tanstack/solid-store'
4import { Field, createField } from './createField'
5import type {
6 FormAsyncValidateOrFn,
7 FormOptions,
8 FormState,
9 FormValidateOrFn,
10} from '@tanstack/form-core'
11import type { JSXElement } from 'solid-js'
12import type { CreateField, FieldComponent } from './createField'
13​
14export interface SolidFormApi<
15 TParentData,
16 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
17 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
18 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
19 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
20 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
21 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
22 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
23 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
24 TSubmitMeta,
25> {
26 Field: FieldComponent<
27 TParentData,
28 TFormOnMount,
29 TFormOnChange,
30 TFormOnChangeAsync,
31 TFormOnBlur,
32 TFormOnBlurAsync,
33 TFormOnSubmit,
34 TFormOnSubmitAsync,
35 TFormOnServer,
36 TSubmitMeta
37 >
38 createField: CreateField<
39 TParentData,
40 TFormOnMount,
41 TFormOnChange,
42 TFormOnChangeAsync,
43 TFormOnBlur,
44 TFormOnBlurAsync,
45 TFormOnSubmit,
46 TFormOnSubmitAsync,
47 TFormOnServer,
48 TSubmitMeta
49 >
50 useStore: <
51 TSelected = NoInfer<
52 FormState<
53 TParentData,
54 TFormOnMount,
55 TFormOnChange,
56 TFormOnChangeAsync,
57 TFormOnBlur,
58 TFormOnBlurAsync,
59 TFormOnSubmit,
60 TFormOnSubmitAsync,
61 TFormOnServer
62 >
63 >,
64 >(
65 selector?: (
66 state: NoInfer<
67 FormState<
68 TParentData,
69 TFormOnMount,
70 TFormOnChange,
71 TFormOnChangeAsync,
72 TFormOnBlur,
73 TFormOnBlurAsync,
74 TFormOnSubmit,
75 TFormOnSubmitAsync,
76 TFormOnServer
77 >
78 >,
79 ) => TSelected,
80 ) => () => TSelected
81 Subscribe: <
82 TSelected = NoInfer<
83 FormState<
84 TParentData,
85 TFormOnMount,
86 TFormOnChange,
87 TFormOnChangeAsync,
88 TFormOnBlur,
89 TFormOnBlurAsync,
90 TFormOnSubmit,
91 TFormOnSubmitAsync,
92 TFormOnServer
93 >
94 >,
95 >(props: {
96 selector?: (
97 state: NoInfer<
98 FormState<
99 TParentData,
100 TFormOnMount,
101 TFormOnChange,
102 TFormOnChangeAsync,
103 TFormOnBlur,
104 TFormOnBlurAsync,
105 TFormOnSubmit,
106 TFormOnSubmitAsync,
107 TFormOnServer
108 >
109 >,
110 ) => TSelected
111 children: ((state: () => NoInfer<TSelected>) => JSXElement) | JSXElement
112 }) => JSXElement
114​
115export function createForm<
116 TParentData,
117 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
118 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
119 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
120 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
121 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
122 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
123 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
124 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
125 TSubmitMeta,
126>(
127 opts?: () => FormOptions<
128 TParentData,
129 TFormOnMount,
130 TFormOnChange,
131 TFormOnChangeAsync,
132 TFormOnBlur,
133 TFormOnBlurAsync,
134 TFormOnSubmit,
135 TFormOnSubmitAsync,
136 TFormOnServer,
137 TSubmitMeta
138 >,
139) {
140 const options = opts?.()
141 const api = new FormApi<
142 TParentData,
143 TFormOnMount,
144 TFormOnChange,
145 TFormOnChangeAsync,
146 TFormOnBlur,
147 TFormOnBlurAsync,
148 TFormOnSubmit,
149 TFormOnSubmitAsync,
150 TFormOnServer,
151 TSubmitMeta
152 >(options)
153 const extendedApi: typeof api &
154 SolidFormApi<
155 TParentData,
156 TFormOnMount,
157 TFormOnChange,
158 TFormOnChangeAsync,
159 TFormOnBlur,
160 TFormOnBlurAsync,
161 TFormOnSubmit,
162 TFormOnSubmitAsync,
163 TFormOnServer,
164 TSubmitMeta
165 > = api as never
166​
167 extendedApi.Field = (props) => <Field {...props} form={api} />
168 extendedApi.createField = (props) =>
169 createField(() => {
170 return { ...props(), form: api }
171 }) as never
172 extendedApi.useStore = (selector) => useStore(api.store, selector)
173 extendedApi.Subscribe = (props) =>
174 functionalUpdate(props.children, useStore(api.store, props.selector))
175​
176 onMount(api.mount)
177​
178 /**
179 * formApi.update should not have any side effects. Think of it like a `useRef`
180 * that we need to keep updated every render with the most up-to-date information.
181 */
182 createComputed(() => api.update(opts?.()))
183​
184 return extendedApi