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

Field.svelte

309 lines9.2 KB

1<script module lang="ts">
2 import {
3 type DeepKeys,
4 type DeepValue,
5 FieldApi,
6 type FieldAsyncValidateOrFn,
7 type FieldValidateOrFn,
8 type FormAsyncValidateOrFn,
9 type FormValidateOrFn,
10 } from '@tanstack/form-core'
11 import { useStore } from '@tanstack/svelte-store'
12 import { onMount, type Snippet } from 'svelte'
13 import Field from './Field.svelte'
14 import type { CreateFieldOptions, SvelteFieldApi } from './types.js'
15​
16 export function createField<
17 TParentData,
18 TName extends DeepKeys<TParentData>,
19 TData extends DeepValue<TParentData, TName>,
20 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
21 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
22 TOnChangeAsync extends
23 | undefined
24 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
25 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
26 TOnBlurAsync extends
27 | undefined
28 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
29 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
30 TOnSubmitAsync extends
31 | undefined
32 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
33 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
34 TOnDynamicAsync extends
35 | undefined
36 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
37 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
38 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
39 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
40 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
41 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
42 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
43 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
44 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
45 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
46 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
47 TParentSubmitMeta,
48 >(
49 opts: () => CreateFieldOptions<
50 TParentData,
51 TName,
52 TData,
53 TOnMount,
54 TOnChange,
55 TOnChangeAsync,
56 TOnBlur,
57 TOnBlurAsync,
58 TOnSubmit,
59 TOnSubmitAsync,
60 TOnDynamic,
61 TOnDynamicAsync,
62 TFormOnMount,
63 TFormOnChange,
64 TFormOnChangeAsync,
65 TFormOnBlur,
66 TFormOnBlurAsync,
67 TFormOnSubmit,
68 TFormOnSubmitAsync,
69 TFormOnDynamic,
70 TFormOnDynamicAsync,
71 TFormOnServer,
72 TParentSubmitMeta
73 >,
74 ) {
75 const options = opts()
76​
77 const api = new FieldApi(options)
78​
79 const extendedApi: typeof api &
80 SvelteFieldApi<
81 TParentData,
82 TFormOnMount,
83 TFormOnChange,
84 TFormOnChangeAsync,
85 TFormOnBlur,
86 TFormOnBlurAsync,
87 TFormOnSubmit,
88 TFormOnSubmitAsync,
89 TFormOnDynamic,
90 TFormOnDynamicAsync,
91 TFormOnServer,
92 TParentSubmitMeta
93 > = api as never
94​
95 extendedApi.Field = Field as never
96​
97 let mounted = false
98 // Instantiates field meta and removes it when unrendered
99 onMount(() => {
100 const cleanupFn = api.mount()
101 mounted = true
102 return () => {
103 cleanupFn()
104 mounted = false
105 }
106 })
107​
108 $effect.pre(() => {
109 // Invoke options function before mounted check, else it wouldn't rerun on changes to options.
110 // Changes to options are seen by the effect because signals inside them are picked up.
111 const current = opts()
112 if (!mounted) return
113 api.update(current)
114 })
115​
116 const storeSub = useStore(api.store)
117 Object.defineProperty(extendedApi, 'state', {
118 get() {
119 return storeSub.current
120 },
121 })
122​
123 return extendedApi
124 }
125</script>
126​
127<script
128 lang="ts"
129 generics="
130 TParentData,
131 TName extends DeepKeys<TParentData>,
132 TData extends DeepValue<TParentData, TName>,
133 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
134 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
135 TOnChangeAsync extends
136 | undefined
137 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
138 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
139 TOnBlurAsync extends
140 | undefined
141 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
142 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
143 TOnSubmitAsync extends
144 | undefined
145 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
146 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
147 TOnDynamicAsync extends
148 | undefined
149 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
150 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
151 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
152 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
153 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
154 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
155 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
156 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
157 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
158 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
159 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
160 TParentSubmitMeta,
163 type Props<
164 TParentData,
165 TName extends DeepKeys<TParentData>,
166 TData extends DeepValue<TParentData, TName>,
167 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
168 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
169 TOnChangeAsync extends
170 | undefined
171 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
172 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
173 TOnBlurAsync extends
174 | undefined
175 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
176 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
177 TOnSubmitAsync extends
178 | undefined
179 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
180 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
181 TOnDynamicAsync extends
182 | undefined
183 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
184 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
185 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
186 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
187 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
188 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
189 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
190 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
191 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
192 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
193 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
194 TParentSubmitMeta,
195 > = {
196 children: Snippet<
197 [
198 FieldApi<
199 TParentData,
200 TName,
201 TData,
202 TOnMount,
203 TOnChange,
204 TOnChangeAsync,
205 TOnBlur,
206 TOnBlurAsync,
207 TOnSubmit,
208 TOnSubmitAsync,
209 TOnDynamic,
210 TOnDynamicAsync,
211 TFormOnMount,
212 TFormOnChange,
213 TFormOnChangeAsync,
214 TFormOnBlur,
215 TFormOnBlurAsync,
216 TFormOnSubmit,
217 TFormOnSubmitAsync,
218 TFormOnDynamic,
219 TFormOnDynamicAsync,
220 TFormOnServer,
221 TParentSubmitMeta
222 >,
223 ]
224 >
225 } & CreateFieldOptions<
226 TParentData,
227 TName,
228 TData,
229 TOnMount,
230 TOnChange,
231 TOnChangeAsync,
232 TOnBlur,
233 TOnBlurAsync,
234 TOnSubmit,
235 TOnSubmitAsync,
236 TOnDynamic,
237 TOnDynamicAsync,
238 TFormOnMount,
239 TFormOnChange,
240 TFormOnChangeAsync,
241 TFormOnBlur,
242 TFormOnBlurAsync,
243 TFormOnSubmit,
244 TFormOnSubmitAsync,
245 TFormOnDynamic,
246 TFormOnDynamicAsync,
247 TFormOnServer,
248 TParentSubmitMeta
249 >
250​
251 let {
252 children,
253 ...fieldOptions
254 }: Props<
255 TParentData,
256 TName,
257 TData,
258 TOnMount,
259 TOnChange,
260 TOnChangeAsync,
261 TOnBlur,
262 TOnBlurAsync,
263 TOnSubmit,
264 TOnSubmitAsync,
265 TOnDynamic,
266 TOnDynamicAsync,
267 TFormOnMount,
268 TFormOnChange,
269 TFormOnChangeAsync,
270 TFormOnBlur,
271 TFormOnBlurAsync,
272 TFormOnSubmit,
273 TFormOnSubmitAsync,
274 TFormOnDynamic,
275 TFormOnDynamicAsync,
276 TFormOnServer,
277 TParentSubmitMeta
278 > = $props()
279​
280 const fieldApi = createField<
281 TParentData,
282 TName,
283 TData,
284 TOnMount,
285 TOnChange,
286 TOnChangeAsync,
287 TOnBlur,
288 TOnBlurAsync,
289 TOnSubmit,
290 TOnSubmitAsync,
291 TOnDynamic,
292 TOnDynamicAsync,
293 TFormOnMount,
294 TFormOnChange,
295 TFormOnChangeAsync,
296 TFormOnBlur,
297 TFormOnBlurAsync,
298 TFormOnSubmit,
299 TFormOnSubmitAsync,
300 TFormOnDynamic,
301 TFormOnDynamicAsync,
302 TFormOnServer,
303 TParentSubmitMeta
304 >(() => {
305 return fieldOptions
306 })
307</script>
308​
309{@render children(fieldApi)}