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

createForm.svelte.ts

306 lines8.5 KB

1import { FormApi } from '@tanstack/form-core'
2import { useStore } from '@tanstack/svelte-store'
3import { onMount } from 'svelte'
4import Field, { createField } from './Field.svelte'
5import Subscribe from './Subscribe.svelte'
6import type {
7 Component,
8 ComponentConstructorOptions,
9 Snippet,
10 SvelteComponent,
11} from 'svelte'
12import type {
13 FormAsyncValidateOrFn,
14 FormOptions,
15 FormState,
16 FormValidateOrFn,
17} from '@tanstack/form-core'
18import type { CreateField, FieldComponent, WithoutFunction } from './types.js'
19​
20export interface SvelteFormApi<
21 TParentData,
22 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
23 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
24 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
25 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
26 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
27 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
28 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
29 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
30 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
31 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
32 TSubmitMeta,
33> {
34 Field: FieldComponent<
35 TParentData,
36 TFormOnMount,
37 TFormOnChange,
38 TFormOnChangeAsync,
39 TFormOnBlur,
40 TFormOnBlurAsync,
41 TFormOnSubmit,
42 TFormOnSubmitAsync,
43 TFormOnDynamic,
44 TFormOnDynamicAsync,
45 TFormOnServer,
46 TSubmitMeta
47 >
48 createField: CreateField<
49 TParentData,
50 TFormOnMount,
51 TFormOnChange,
52 TFormOnChangeAsync,
53 TFormOnBlur,
54 TFormOnBlurAsync,
55 TFormOnSubmit,
56 TFormOnSubmitAsync,
57 TFormOnDynamic,
58 TFormOnDynamicAsync,
59 TFormOnServer,
60 TSubmitMeta
61 >
62 useStore: <
63 TSelected = NoInfer<
64 FormState<
65 TParentData,
66 TFormOnMount,
67 TFormOnChange,
68 TFormOnChangeAsync,
69 TFormOnBlur,
70 TFormOnBlurAsync,
71 TFormOnSubmit,
72 TFormOnSubmitAsync,
73 TFormOnDynamic,
74 TFormOnDynamicAsync,
75 TFormOnServer
76 >
77 >,
78 >(
79 selector?: (
80 state: NoInfer<
81 FormState<
82 TParentData,
83 TFormOnMount,
84 TFormOnChange,
85 TFormOnChangeAsync,
86 TFormOnBlur,
87 TFormOnBlurAsync,
88 TFormOnSubmit,
89 TFormOnSubmitAsync,
90 TFormOnDynamic,
91 TFormOnDynamicAsync,
92 TFormOnServer
93 >
94 >,
95 ) => TSelected,
96 ) => { current: TSelected }
97 // This giant type allows the type
98 // - to be used as a function (which they are now in Svelte 5)
99 // - to be used as a class (which they were in Svelte 4, and which Svelte intellisense still uses for backwards compat)
100 // - to preserve the generics correctly
101 // Once Svelte intellisense no longer has/needs backwards compat, we can remove the class constructor part
102 Subscribe: (<
103 TSelected = NoInfer<
104 FormState<
105 TParentData,
106 TFormOnMount,
107 TFormOnChange,
108 TFormOnChangeAsync,
109 TFormOnBlur,
110 TFormOnBlurAsync,
111 TFormOnSubmit,
112 TFormOnSubmitAsync,
113 TFormOnDynamic,
114 TFormOnDynamicAsync,
115 TFormOnServer
116 >
117 >,
118 >(
119 internal: any,
120 props: {
121 selector?: (
122 state: NoInfer<
123 FormState<
124 TParentData,
125 TFormOnMount,
126 TFormOnChange,
127 TFormOnChangeAsync,
128 TFormOnBlur,
129 TFormOnBlurAsync,
130 TFormOnSubmit,
131 TFormOnSubmitAsync,
132 TFormOnDynamic,
133 TFormOnDynamicAsync,
134 TFormOnServer
135 >
136 >,
137 ) => TSelected
138 children: Snippet<[NoInfer<TSelected>]>
139 },
140 ) => {}) &
141 (new <
142 TSelected = NoInfer<
143 FormState<
144 TParentData,
145 TFormOnMount,
146 TFormOnChange,
147 TFormOnChangeAsync,
148 TFormOnBlur,
149 TFormOnBlurAsync,
150 TFormOnSubmit,
151 TFormOnSubmitAsync,
152 TFormOnDynamic,
153 TFormOnDynamicAsync,
154 TFormOnServer
155 >
156 >,
157 >(
158 opts: ComponentConstructorOptions<{
159 selector?: (
160 state: NoInfer<
161 FormState<
162 TParentData,
163 TFormOnMount,
164 TFormOnChange,
165 TFormOnChangeAsync,
166 TFormOnBlur,
167 TFormOnBlurAsync,
168 TFormOnSubmit,
169 TFormOnSubmitAsync,
170 TFormOnDynamic,
171 TFormOnDynamicAsync,
172 TFormOnServer
173 >
174 >,
175 ) => TSelected
176 children: Snippet<[NoInfer<TSelected>]>
177 }>,
178 ) => SvelteComponent) &
179 WithoutFunction<Component>
181​
182/**
183 * An extended version of the `FormApi` class that includes Svelte-specific functionalities from `SvelteFormApi`
184 */
185export type SvelteFormExtendedApi<
186 TFormData,
187 TOnMount extends undefined | FormValidateOrFn<TFormData>,
188 TOnChange extends undefined | FormValidateOrFn<TFormData>,
189 TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
190 TOnBlur extends undefined | FormValidateOrFn<TFormData>,
191 TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
192 TOnSubmit extends undefined | FormValidateOrFn<TFormData>,
193 TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
194 TOnDynamic extends undefined | FormValidateOrFn<TFormData>,
195 TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>,
196 TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,
197 TSubmitMeta,
198> = FormApi<
199 TFormData,
200 TOnMount,
201 TOnChange,
202 TOnChangeAsync,
203 TOnBlur,
204 TOnBlurAsync,
205 TOnSubmit,
206 TOnSubmitAsync,
207 TOnDynamic,
208 TOnDynamicAsync,
209 TOnServer,
210 TSubmitMeta
211> &
212 SvelteFormApi<
213 TFormData,
214 TOnMount,
215 TOnChange,
216 TOnChangeAsync,
217 TOnBlur,
218 TOnBlurAsync,
219 TOnSubmit,
220 TOnSubmitAsync,
221 TOnDynamic,
222 TOnDynamicAsync,
223 TOnServer,
224 TSubmitMeta
225 >
226​
227export function createForm<
228 TParentData,
229 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
230 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
231 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
232 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
233 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
234 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
235 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
236 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
237 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
238 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
239 TSubmitMeta,
240>(
241 opts?: () => FormOptions<
242 TParentData,
243 TFormOnMount,
244 TFormOnChange,
245 TFormOnChangeAsync,
246 TFormOnBlur,
247 TFormOnBlurAsync,
248 TFormOnSubmit,
249 TFormOnSubmitAsync,
250 TFormOnDynamic,
251 TFormOnDynamicAsync,
252 TFormOnServer,
253 TSubmitMeta
254 >,
255) {
256 const options = opts?.()
257 const api = new FormApi<
258 TParentData,
259 TFormOnMount,
260 TFormOnChange,
261 TFormOnChangeAsync,
262 TFormOnBlur,
263 TFormOnBlurAsync,
264 TFormOnSubmit,
265 TFormOnSubmitAsync,
266 TFormOnDynamic,
267 TFormOnDynamicAsync,
268 TFormOnServer,
269 TSubmitMeta
270 >(options)
271 const extendedApi: typeof api &
272 SvelteFormApi<
273 TParentData,
274 TFormOnMount,
275 TFormOnChange,
276 TFormOnChangeAsync,
277 TFormOnBlur,
278 TFormOnBlurAsync,
279 TFormOnSubmit,
280 TFormOnSubmitAsync,
281 TFormOnDynamic,
282 TFormOnDynamicAsync,
283 TFormOnServer,
284 TSubmitMeta
285 > = api as never
286​
287 // @ts-expect-error constructor definition exists only on a type level
288 extendedApi.Field = (internal, props) =>
289 Field(internal, { ...props, form: api as never } as never)
290 extendedApi.createField = (props) =>
291 createField(() => {
292 return { ...props(), form: api } as never
293 }) as never // Type cast because else "Error: Type instantiation is excessively deep and possibly infinite."
294 extendedApi.useStore = (selector) => useStore(api.store, selector)
295 // @ts-expect-error constructor definition exists only on a type level
296 extendedApi.Subscribe = (internal, props) =>
297 Subscribe(internal, { ...props, store: api.store })
298​
299 onMount(api.mount)
300​
301 // formApi.update should not have any side effects. Think of it like a `useRef`
302 // that we need to keep updated every render with the most up-to-date information.
303 $effect.pre(() => api.update(opts?.()))
304​
305 return extendedApi