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

tanstack-form-controller.ts

552 lines14.4 KB

1import { nothing } from 'lit'
2import { PartType, directive } from 'lit/directive.js'
3import { FieldApi, FormApi } from '@tanstack/form-core'
4import { AsyncDirective } from 'lit/async-directive.js'
5import type {
6 DeepKeys,
7 DeepValue,
8 FieldAsyncValidateOrFn,
9 FieldOptions,
10 FieldValidateOrFn,
11 FormAsyncValidateOrFn,
12 FormOptions,
13 FormValidateOrFn,
14} from '@tanstack/form-core'
15import type { ElementPart, PartInfo } from 'lit/directive.js'
16import type { ReactiveController, ReactiveControllerHost } from 'lit'
17​
18type renderCallback<
19 TParentData,
20 TName extends DeepKeys<TParentData>,
21 TData extends DeepValue<TParentData, TName>,
22 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
23 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
24 TOnChangeAsync extends
25 | undefined
26 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
27 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
28 TOnBlurAsync extends
29 | undefined
30 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
31 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
32 TOnSubmitAsync extends
33 | undefined
34 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
35 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
36 TOnDynamicAsync extends
37 | undefined
38 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
39 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
40 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
41 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
42 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
43 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
44 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
45 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
46 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
47 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
48 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
49 TParentSubmitMeta,
50> = (
51 fieldOptions: FieldApi<
52 TParentData,
53 TName,
54 TData,
55 TOnMount,
56 TOnChange,
57 TOnChangeAsync,
58 TOnBlur,
59 TOnBlurAsync,
60 TOnSubmit,
61 TOnSubmitAsync,
62 TOnDynamic,
63 TOnDynamicAsync,
64 TFormOnMount,
65 TFormOnChange,
66 TFormOnChangeAsync,
67 TFormOnBlur,
68 TFormOnBlurAsync,
69 TFormOnSubmit,
70 TFormOnSubmitAsync,
71 TFormOnDynamic,
72 TFormOnDynamicAsync,
73 TFormOnServer,
74 TParentSubmitMeta
75 >,
76) => unknown
77​
78type fieldDirectiveType<
79 TParentData,
80 TName extends DeepKeys<TParentData>,
81 TData extends DeepValue<TParentData, TName>,
82 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
83 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
84 TOnChangeAsync extends
85 | undefined
86 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
87 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
88 TOnBlurAsync extends
89 | undefined
90 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
91 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
92 TOnSubmitAsync extends
93 | undefined
94 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
95 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
96 TOnDynamicAsync extends
97 | undefined
98 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
99 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
100 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
101 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
102 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
103 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
104 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
105 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
106 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
107 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
108 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
109 TSubmitMeta,
110> = (
111 form: FormApi<
112 TParentData,
113 TFormOnMount,
114 TFormOnChange,
115 TFormOnChangeAsync,
116 TFormOnBlur,
117 TFormOnBlurAsync,
118 TFormOnSubmit,
119 TFormOnSubmitAsync,
120 TFormOnDynamic,
121 TFormOnDynamicAsync,
122 TFormOnServer,
123 TSubmitMeta
124 >,
125 options: FieldOptions<
126 TParentData,
127 TName,
128 TData,
129 TOnMount,
130 TOnChange,
131 TOnChangeAsync,
132 TOnBlur,
133 TOnBlurAsync,
134 TOnSubmit,
135 TOnSubmitAsync,
136 TOnDynamic,
137 TOnDynamicAsync
138 >,
139 render: renderCallback<
140 TParentData,
141 TName,
142 TData,
143 TOnMount,
144 TOnChange,
145 TOnChangeAsync,
146 TOnBlur,
147 TOnBlurAsync,
148 TOnSubmit,
149 TOnSubmitAsync,
150 TOnDynamic,
151 TOnDynamicAsync,
152 TFormOnMount,
153 TFormOnChange,
154 TFormOnChangeAsync,
155 TFormOnBlur,
156 TFormOnBlurAsync,
157 TFormOnSubmit,
158 TFormOnSubmitAsync,
159 TFormOnDynamic,
160 TFormOnDynamicAsync,
161 TFormOnServer,
162 TSubmitMeta
163 >,
164) => {
165 values: {
166 form: FormApi<
167 TParentData,
168 TFormOnMount,
169 TFormOnChange,
170 TFormOnChangeAsync,
171 TFormOnBlur,
172 TFormOnBlurAsync,
173 TFormOnSubmit,
174 TFormOnSubmitAsync,
175 TFormOnDynamic,
176 TFormOnDynamicAsync,
177 TFormOnServer,
178 TSubmitMeta
179 >
180 options: FieldOptions<
181 TParentData,
182 TName,
183 TData,
184 TOnMount,
185 TOnChange,
186 TOnChangeAsync,
187 TOnBlur,
188 TOnBlurAsync,
189 TOnSubmit,
190 TOnSubmitAsync,
191 TOnDynamic,
192 TOnDynamicAsync
193 >
194 render: renderCallback<
195 TParentData,
196 TName,
197 TData,
198 TOnMount,
199 TOnChange,
200 TOnChangeAsync,
201 TOnBlur,
202 TOnBlurAsync,
203 TOnSubmit,
204 TOnSubmitAsync,
205 TOnDynamic,
206 TOnDynamicAsync,
207 TFormOnMount,
208 TFormOnChange,
209 TFormOnChangeAsync,
210 TFormOnBlur,
211 TFormOnBlurAsync,
212 TFormOnSubmit,
213 TFormOnSubmitAsync,
214 TFormOnDynamic,
215 TFormOnDynamicAsync,
216 TFormOnServer,
217 TSubmitMeta
218 >
219 }
221​
222export class TanStackFormController<
223 TParentData,
224 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
225 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
226 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
227 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
228 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
229 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
230 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
231 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
232 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
233 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
234 TSubmitMeta,
235> implements ReactiveController
237 #host: ReactiveControllerHost
238 #subscription?: () => void
239​
240 api: FormApi<
241 TParentData,
242 TFormOnMount,
243 TFormOnChange,
244 TFormOnChangeAsync,
245 TFormOnBlur,
246 TFormOnBlurAsync,
247 TFormOnSubmit,
248 TFormOnSubmitAsync,
249 TFormOnDynamic,
250 TFormOnDynamicAsync,
251 TFormOnServer,
252 TSubmitMeta
253 >
254​
255 constructor(
256 host: ReactiveControllerHost,
257 config?: FormOptions<
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 >,
271 ) {
272 this.api = new FormApi<
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 >(config)
286 ;(this.#host = host).addController(this)
287 }
288​
289 hostConnected() {
290 this.#subscription = this.api.store.subscribe(() => {
291 this.#host.requestUpdate()
292 })
293 }
294​
295 hostDisconnected() {
296 this.#subscription?.()
297 }
298​
299 field<
300 TName extends DeepKeys<TParentData>,
301 TData extends DeepValue<TParentData, TName>,
302 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
303 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
304 TOnChangeAsync extends
305 | undefined
306 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
307 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
308 TOnBlurAsync extends
309 | undefined
310 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
311 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
312 TOnSubmitAsync extends
313 | undefined
314 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
315 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
316 TOnDynamicAsync extends
317 | undefined
318 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
319 >(
320 fieldConfig: FieldOptions<
321 TParentData,
322 TName,
323 TData,
324 TOnMount,
325 TOnChange,
326 TOnChangeAsync,
327 TOnBlur,
328 TOnBlurAsync,
329 TOnSubmit,
330 TOnSubmitAsync,
331 TOnDynamic,
332 TOnDynamicAsync
333 >,
334 render: renderCallback<
335 TParentData,
336 TName,
337 TData,
338 TOnMount,
339 TOnChange,
340 TOnChangeAsync,
341 TOnBlur,
342 TOnBlurAsync,
343 TOnSubmit,
344 TOnSubmitAsync,
345 TOnDynamic,
346 TOnDynamicAsync,
347 TFormOnMount,
348 TFormOnChange,
349 TFormOnChangeAsync,
350 TFormOnBlur,
351 TFormOnBlurAsync,
352 TFormOnSubmit,
353 TFormOnSubmitAsync,
354 TFormOnDynamic,
355 TFormOnDynamicAsync,
356 TFormOnServer,
357 TSubmitMeta
358 >,
359 ) {
360 return (
361 fieldDirective as unknown as fieldDirectiveType<
362 TParentData,
363 TName,
364 TData,
365 TOnMount,
366 TOnChange,
367 TOnChangeAsync,
368 TOnBlur,
369 TOnBlurAsync,
370 TOnSubmit,
371 TOnSubmitAsync,
372 TOnDynamic,
373 TOnDynamicAsync,
374 TFormOnMount,
375 TFormOnChange,
376 TFormOnChangeAsync,
377 TFormOnBlur,
378 TFormOnBlurAsync,
379 TFormOnSubmit,
380 TFormOnSubmitAsync,
381 TFormOnDynamic,
382 TFormOnDynamicAsync,
383 TFormOnServer,
384 TSubmitMeta
385 >
386 )(this.api, fieldConfig, render)
387 }
389​
390class FieldDirective<
391 TParentData,
392 TName extends DeepKeys<TParentData>,
393 TData extends DeepValue<TParentData, TName>,
394 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
395 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
396 TOnChangeAsync extends
397 | undefined
398 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
399 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
400 TOnBlurAsync extends
401 | undefined
402 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
403 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
404 TOnSubmitAsync extends
405 | undefined
406 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
407 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
408 TOnDynamicAsync extends
409 | undefined
410 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
411 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
412 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
413 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
414 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
415 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
416 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
417 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
418 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
419 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
420 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
421 TSubmitMeta,
422> extends AsyncDirective {
423 #registered = false
424 #field?: FieldApi<
425 TParentData,
426 TName,
427 TData,
428 TOnMount,
429 TOnChange,
430 TOnChangeAsync,
431 TOnBlur,
432 TOnBlurAsync,
433 TOnSubmit,
434 TOnSubmitAsync,
435 TOnDynamic,
436 TOnDynamicAsync,
437 TFormOnMount,
438 TFormOnChange,
439 TFormOnChangeAsync,
440 TFormOnBlur,
441 TFormOnBlurAsync,
442 TFormOnSubmit,
443 TFormOnSubmitAsync,
444 TFormOnDynamic,
445 TFormOnDynamicAsync,
446 TFormOnServer,
447 TSubmitMeta
448 >
449 #unmount?: () => void
450​
451 constructor(partInfo: PartInfo) {
452 super(partInfo)
453 if (partInfo.type !== PartType.CHILD) {
454 throw new Error(
455 'The `field` directive must be used in the `child` attribute',
456 )
457 }
458 }
459​
460 update(
461 _: ElementPart,
462 [form, fieldConfig, _render]: Parameters<this['render']>,
463 ) {
464 if (!this.#registered) {
465 if (!this.#field) {
466 const options = { ...fieldConfig, form }
467​
468 this.#field = new FieldApi(options)
469 this.#unmount = this.#field.mount()
470 }
471​
472 this.#registered = true
473 }
474​
475 return this.render(form, fieldConfig, _render)
476 }
477​
478 protected disconnected() {
479 super.disconnected()
480 this.#unmount?.()
481 }
482​
483 protected reconnected() {
484 super.reconnected()
485 if (this.#field) {
486 this.#unmount = this.#field.mount()
487 }
488 }
489​
490 render(
491 _form: FormApi<
492 TParentData,
493 TFormOnMount,
494 TFormOnChange,
495 TFormOnChangeAsync,
496 TFormOnBlur,
497 TFormOnBlurAsync,
498 TFormOnSubmit,
499 TFormOnSubmitAsync,
500 TFormOnDynamic,
501 TFormOnDynamicAsync,
502 TFormOnServer,
503 TSubmitMeta
504 >,
505 _fieldConfig: FieldOptions<
506 TParentData,
507 TName,
508 TData,
509 TOnMount,
510 TOnChange,
511 TOnChangeAsync,
512 TOnBlur,
513 TOnBlurAsync,
514 TOnSubmit,
515 TOnSubmitAsync,
516 TOnDynamic,
517 TOnDynamicAsync
518 >,
519 _renderCallback: renderCallback<
520 TParentData,
521 TName,
522 TData,
523 TOnMount,
524 TOnChange,
525 TOnChangeAsync,
526 TOnBlur,
527 TOnBlurAsync,
528 TOnSubmit,
529 TOnSubmitAsync,
530 TOnDynamic,
531 TOnDynamicAsync,
532 TFormOnMount,
533 TFormOnChange,
534 TFormOnChangeAsync,
535 TFormOnBlur,
536 TFormOnBlurAsync,
537 TFormOnSubmit,
538 TFormOnSubmitAsync,
539 TFormOnDynamic,
540 TFormOnDynamicAsync,
541 TFormOnServer,
542 TSubmitMeta
543 >,
544 ) {
545 if (this.#field) {
546 return _renderCallback(this.#field)
547 }
548 return nothing
549 }
551​
552const fieldDirective = directive(FieldDirective)