Open History to see the last commit
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 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
24 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
25 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
26 TSubmitMeta,
27> {
28 Field: FieldComponent<
29 TParentData,
30 TFormOnMount,
31 TFormOnChange,
32 TFormOnChangeAsync,
33 TFormOnBlur,
34 TFormOnBlurAsync,
35 TFormOnSubmit,
36 TFormOnSubmitAsync,
37 TFormOnDynamic,
38 TFormOnDynamicAsync,
39 TFormOnServer,
40 TSubmitMeta
41 >
42 createField: CreateField<
43 TParentData,
44 TFormOnMount,
45 TFormOnChange,
46 TFormOnChangeAsync,
47 TFormOnBlur,
48 TFormOnBlurAsync,
49 TFormOnSubmit,
50 TFormOnSubmitAsync,
51 TFormOnDynamic,
52 TFormOnDynamicAsync,
53 TFormOnServer,
54 TSubmitMeta
55 >
56 useStore: <
57 TSelected = NoInfer<
58 FormState<
59 TParentData,
60 TFormOnMount,
61 TFormOnChange,
62 TFormOnChangeAsync,
63 TFormOnBlur,
64 TFormOnBlurAsync,
65 TFormOnSubmit,
66 TFormOnSubmitAsync,
67 TFormOnDynamic,
68 TFormOnDynamicAsync,
69 TFormOnServer
70 >
71 >,
72 >(
73 selector?: (
74 state: NoInfer<
75 FormState<
76 TParentData,
77 TFormOnMount,
78 TFormOnChange,
79 TFormOnChangeAsync,
80 TFormOnBlur,
81 TFormOnBlurAsync,
82 TFormOnSubmit,
83 TFormOnSubmitAsync,
84 TFormOnDynamic,
85 TFormOnDynamicAsync,
86 TFormOnServer
87 >
88 >,
89 ) => TSelected,
90 ) => () => TSelected
91 Subscribe: <
92 TSelected = NoInfer<
93 FormState<
94 TParentData,
95 TFormOnMount,
96 TFormOnChange,
97 TFormOnChangeAsync,
98 TFormOnBlur,
99 TFormOnBlurAsync,
100 TFormOnSubmit,
101 TFormOnSubmitAsync,
102 TFormOnDynamic,
103 TFormOnDynamicAsync,
104 TFormOnServer
105 >
106 >,
107 >(props: {
108 selector?: (
109 state: NoInfer<
110 FormState<
111 TParentData,
112 TFormOnMount,
113 TFormOnChange,
114 TFormOnChangeAsync,
115 TFormOnBlur,
116 TFormOnBlurAsync,
117 TFormOnSubmit,
118 TFormOnSubmitAsync,
119 TFormOnDynamic,
120 TFormOnDynamicAsync,
121 TFormOnServer
122 >
123 >,
124 ) => TSelected
125 children: ((state: () => NoInfer<TSelected>) => JSXElement) | JSXElement
126 }) => JSXElement
127}
128β
129/**
130 * An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi`
131 */
132export type SolidFormExtendedApi<
133 TFormData,
134 TOnMount extends undefined | FormValidateOrFn<TFormData>,
135 TOnChange extends undefined | FormValidateOrFn<TFormData>,
136 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
137 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
138 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
139 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
140 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
141 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
142 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
143 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
144 TSubmitMeta,
145> = FormApi<
146 TFormData,
147 TOnMount,
148 TOnChange,
149 TOnChangeAsync,
150 TOnBlur,
151 TOnBlurAsync,
152 TOnSubmit,
153 TOnSubmitAsync,
154 TOnDynamic,
155 TOnDynamicAsync,
156 TOnServer,
157 TSubmitMeta
158> &
159 SolidFormApi<
160 TFormData,
161 TOnMount,
162 TOnChange,
163 TOnChangeAsync,
164 TOnBlur,
165 TOnBlurAsync,
166 TOnSubmit,
167 TOnSubmitAsync,
168 TOnDynamic,
169 TOnDynamicAsync,
170 TOnServer,
171 TSubmitMeta
172 >
173export function createForm<
174 TParentData,
175 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
176 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
177 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
178 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
179 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
180 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
181 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
182 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
183 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
184 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
185 TSubmitMeta,
186>(
187 opts?: () => FormOptions<
188 TParentData,
189 TFormOnMount,
190 TFormOnChange,
191 TFormOnChangeAsync,
192 TFormOnBlur,
193 TFormOnBlurAsync,
194 TFormOnSubmit,
195 TFormOnSubmitAsync,
196 TFormOnDynamic,
197 TFormOnDynamicAsync,
198 TFormOnServer,
199 TSubmitMeta
200 >,
201) {
202 const options = opts?.()
203 const api = new FormApi<
204 TParentData,
205 TFormOnMount,
206 TFormOnChange,
207 TFormOnChangeAsync,
208 TFormOnBlur,
209 TFormOnBlurAsync,
210 TFormOnSubmit,
211 TFormOnSubmitAsync,
212 TFormOnDynamic,
213 TFormOnDynamicAsync,
214 TFormOnServer,
215 TSubmitMeta
216 >(options)
217 const extendedApi: typeof api &
218 SolidFormApi<
219 TParentData,
220 TFormOnMount,
221 TFormOnChange,
222 TFormOnChangeAsync,
223 TFormOnBlur,
224 TFormOnBlurAsync,
225 TFormOnSubmit,
226 TFormOnSubmitAsync,
227 TFormOnDynamic,
228 TFormOnDynamicAsync,
229 TFormOnServer,
230 TSubmitMeta
231 > = api as never
232β
233 extendedApi.Field = (props) => <Field {...props} form={api} />
234 extendedApi.createField = (props) =>
235 createField(() => {
236 return { ...props(), form: api }
237 }) as never
238 extendedApi.useStore = (selector) => useStore(api.store, selector)
239 extendedApi.Subscribe = (props) =>
240 functionalUpdate(props.children, useStore(api.store, props.selector))
241β
242 onMount(api.mount)
243β
244 /**
245 * formApi.update should not have any side effects. Think of it like a `useRef`
246 * that we need to keep updated every render with the most up-to-date information.
247 */
248 createComputed(() => api.update(opts?.()))
249β
250 return extendedApi
251}