Open History to see the last commit
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 }
220}
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 {
236 #host: ReactiveControllerHost
237 #subscription?: () => void
238β
239 api: FormApi<
240 TParentData,
241 TFormOnMount,
242 TFormOnChange,
243 TFormOnChangeAsync,
244 TFormOnBlur,
245 TFormOnBlurAsync,
246 TFormOnSubmit,
247 TFormOnSubmitAsync,
248 TFormOnDynamic,
249 TFormOnDynamicAsync,
250 TFormOnServer,
251 TSubmitMeta
252 >
253β
254 constructor(
255 host: ReactiveControllerHost,
256 config?: FormOptions<
257 TParentData,
258 TFormOnMount,
259 TFormOnChange,
260 TFormOnChangeAsync,
261 TFormOnBlur,
262 TFormOnBlurAsync,
263 TFormOnSubmit,
264 TFormOnSubmitAsync,
265 TFormOnDynamic,
266 TFormOnDynamicAsync,
267 TFormOnServer,
268 TSubmitMeta
269 >,
270 ) {
271 this.api = new FormApi<
272 TParentData,
273 TFormOnMount,
274 TFormOnChange,
275 TFormOnChangeAsync,
276 TFormOnBlur,
277 TFormOnBlurAsync,
278 TFormOnSubmit,
279 TFormOnSubmitAsync,
280 TFormOnDynamic,
281 TFormOnDynamicAsync,
282 TFormOnServer,
283 TSubmitMeta
284 >(config)
285 ;(this.#host = host).addController(this)
286 }
287β
288 hostConnected() {
289 this.#subscription = this.api.store.subscribe(() => {
290 this.#host.requestUpdate()
291 }).unsubscribe
292 }
293β
294 hostDisconnected() {
295 this.#subscription?.()
296 }
297β
298 field<
299 TName extends DeepKeys<TParentData>,
300 TData extends DeepValue<TParentData, TName>,
301 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
302 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
303 TOnChangeAsync extends
304 | undefined
305 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
306 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
307 TOnBlurAsync extends
308 | undefined
309 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
310 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
311 TOnSubmitAsync extends
312 | undefined
313 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
314 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
315 TOnDynamicAsync extends
316 | undefined
317 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
318 >(
319 fieldConfig: FieldOptions<
320 TParentData,
321 TName,
322 TData,
323 TOnMount,
324 TOnChange,
325 TOnChangeAsync,
326 TOnBlur,
327 TOnBlurAsync,
328 TOnSubmit,
329 TOnSubmitAsync,
330 TOnDynamic,
331 TOnDynamicAsync
332 >,
333 render: renderCallback<
334 TParentData,
335 TName,
336 TData,
337 TOnMount,
338 TOnChange,
339 TOnChangeAsync,
340 TOnBlur,
341 TOnBlurAsync,
342 TOnSubmit,
343 TOnSubmitAsync,
344 TOnDynamic,
345 TOnDynamicAsync,
346 TFormOnMount,
347 TFormOnChange,
348 TFormOnChangeAsync,
349 TFormOnBlur,
350 TFormOnBlurAsync,
351 TFormOnSubmit,
352 TFormOnSubmitAsync,
353 TFormOnDynamic,
354 TFormOnDynamicAsync,
355 TFormOnServer,
356 TSubmitMeta
357 >,
358 ) {
359 return (
360 fieldDirective as unknown as fieldDirectiveType<
361 TParentData,
362 TName,
363 TData,
364 TOnMount,
365 TOnChange,
366 TOnChangeAsync,
367 TOnBlur,
368 TOnBlurAsync,
369 TOnSubmit,
370 TOnSubmitAsync,
371 TOnDynamic,
372 TOnDynamicAsync,
373 TFormOnMount,
374 TFormOnChange,
375 TFormOnChangeAsync,
376 TFormOnBlur,
377 TFormOnBlurAsync,
378 TFormOnSubmit,
379 TFormOnSubmitAsync,
380 TFormOnDynamic,
381 TFormOnDynamicAsync,
382 TFormOnServer,
383 TSubmitMeta
384 >
385 )(this.api, fieldConfig, render)
386 }
387}
388β
389class FieldDirective<
390 TParentData,
391 TName extends DeepKeys<TParentData>,
392 TData extends DeepValue<TParentData, TName>,
393 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
394 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
395 TOnChangeAsync extends
396 | undefined
397 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
398 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
399 TOnBlurAsync extends
400 | undefined
401 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
402 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
403 TOnSubmitAsync extends
404 | undefined
405 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
406 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
407 TOnDynamicAsync extends
408 | undefined
409 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
410 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
411 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
412 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
413 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
414 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
415 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
416 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
417 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
418 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
419 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
420 TSubmitMeta,
421> extends AsyncDirective {
422 #registered = false
423 #field?: FieldApi<
424 TParentData,
425 TName,
426 TData,
427 TOnMount,
428 TOnChange,
429 TOnChangeAsync,
430 TOnBlur,
431 TOnBlurAsync,
432 TOnSubmit,
433 TOnSubmitAsync,
434 TOnDynamic,
435 TOnDynamicAsync,
436 TFormOnMount,
437 TFormOnChange,
438 TFormOnChangeAsync,
439 TFormOnBlur,
440 TFormOnBlurAsync,
441 TFormOnSubmit,
442 TFormOnSubmitAsync,
443 TFormOnDynamic,
444 TFormOnDynamicAsync,
445 TFormOnServer,
446 TSubmitMeta
447 >
448 #unmount?: () => void
449β
450 constructor(partInfo: PartInfo) {
451 super(partInfo)
452 if (partInfo.type !== PartType.CHILD) {
453 throw new Error(
454 'The `field` directive must be used in the `child` attribute',
455 )
456 }
457 }
458β
459 update(
460 _: ElementPart,
461 [form, fieldConfig, _render]: Parameters<this['render']>,
462 ) {
463 if (!this.#registered) {
464 if (!this.#field) {
465 const options = { ...fieldConfig, form }
466β
467 this.#field = new FieldApi(options)
468 this.#unmount = this.#field.mount()
469 }
470β
471 this.#registered = true
472 }
473β
474 return this.render(form, fieldConfig, _render)
475 }
476β
477 protected disconnected() {
478 super.disconnected()
479 this.#unmount?.()
480 }
481β
482 protected reconnected() {
483 super.reconnected()
484 if (this.#field) {
485 this.#unmount = this.#field.mount()
486 }
487 }
488β
489 render(
490 _form: FormApi<
491 TParentData,
492 TFormOnMount,
493 TFormOnChange,
494 TFormOnChangeAsync,
495 TFormOnBlur,
496 TFormOnBlurAsync,
497 TFormOnSubmit,
498 TFormOnSubmitAsync,
499 TFormOnDynamic,
500 TFormOnDynamicAsync,
501 TFormOnServer,
502 TSubmitMeta
503 >,
504 _fieldConfig: FieldOptions<
505 TParentData,
506 TName,
507 TData,
508 TOnMount,
509 TOnChange,
510 TOnChangeAsync,
511 TOnBlur,
512 TOnBlurAsync,
513 TOnSubmit,
514 TOnSubmitAsync,
515 TOnDynamic,
516 TOnDynamicAsync
517 >,
518 _renderCallback: renderCallback<
519 TParentData,
520 TName,
521 TData,
522 TOnMount,
523 TOnChange,
524 TOnChangeAsync,
525 TOnBlur,
526 TOnBlurAsync,
527 TOnSubmit,
528 TOnSubmitAsync,
529 TOnDynamic,
530 TOnDynamicAsync,
531 TFormOnMount,
532 TFormOnChange,
533 TFormOnChangeAsync,
534 TFormOnBlur,
535 TFormOnBlurAsync,
536 TFormOnSubmit,
537 TFormOnSubmitAsync,
538 TFormOnDynamic,
539 TFormOnDynamicAsync,
540 TFormOnServer,
541 TSubmitMeta
542 >,
543 ) {
544 if (this.#field) {
545 return _renderCallback(this.#field)
546 }
547 return nothing
548 }
549}
550β
551const fieldDirective = directive(FieldDirective)