Open History to see the last commit
1import { nothing } from 'lit'
2import { PartType, directive } from 'lit/directive.js'
3import { FieldApi, FormApi, FormGroupApi } from '@tanstack/form-core'
4import { AsyncDirective } from 'lit/async-directive.js'
5import { TanStackStoreSelector } from '@tanstack/lit-store'
6import type {
7 DeepKeys,
8 DeepValue,
9 FieldAsyncValidateOrFn,
10 FieldOptions,
11 FieldValidateOrFn,
12 FormAsyncValidateOrFn,
13 FormGroupApiOptions,
14 FormGroupAsyncValidateOrFn,
15 FormGroupValidateOrFn,
16 FormOptions,
17 FormValidateOrFn,
18} from '@tanstack/form-core'
19import type { ElementPart, PartInfo } from 'lit/directive.js'
20import type { ReactiveController, ReactiveControllerHost } from 'lit'
21β
22type renderCallback<
23 TParentData,
24 TName extends DeepKeys<TParentData>,
25 TData extends DeepValue<TParentData, TName>,
26 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
27 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
28 TOnChangeAsync extends
29 | undefined
30 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
31 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
32 TOnBlurAsync extends
33 | undefined
34 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
35 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
36 TOnSubmitAsync extends
37 | undefined
38 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
39 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
40 TOnDynamicAsync extends
41 | undefined
42 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
43 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
44 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
45 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
46 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
47 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
48 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
49 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
50 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
51 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
52 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
53 TParentSubmitMeta,
54> = (
55 fieldOptions: FieldApi<
56 TParentData,
57 TName,
58 TData,
59 TOnMount,
60 TOnChange,
61 TOnChangeAsync,
62 TOnBlur,
63 TOnBlurAsync,
64 TOnSubmit,
65 TOnSubmitAsync,
66 TOnDynamic,
67 TOnDynamicAsync,
68 TFormOnMount,
69 TFormOnChange,
70 TFormOnChangeAsync,
71 TFormOnBlur,
72 TFormOnBlurAsync,
73 TFormOnSubmit,
74 TFormOnSubmitAsync,
75 TFormOnDynamic,
76 TFormOnDynamicAsync,
77 TFormOnServer,
78 TParentSubmitMeta
79 >,
80) => unknown
81β
82type fieldDirectiveType<
83 TParentData,
84 TName extends DeepKeys<TParentData>,
85 TData extends DeepValue<TParentData, TName>,
86 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
87 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
88 TOnChangeAsync extends
89 | undefined
90 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
91 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
92 TOnBlurAsync extends
93 | undefined
94 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
95 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
96 TOnSubmitAsync extends
97 | undefined
98 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
99 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
100 TOnDynamicAsync extends
101 | undefined
102 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
103 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
104 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
105 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
106 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
107 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
108 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
109 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
110 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
111 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
112 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
113 TSubmitMeta,
114> = (
115 form: FormApi<
116 TParentData,
117 TFormOnMount,
118 TFormOnChange,
119 TFormOnChangeAsync,
120 TFormOnBlur,
121 TFormOnBlurAsync,
122 TFormOnSubmit,
123 TFormOnSubmitAsync,
124 TFormOnDynamic,
125 TFormOnDynamicAsync,
126 TFormOnServer,
127 TSubmitMeta
128 >,
129 options: FieldOptions<
130 TParentData,
131 TName,
132 TData,
133 TOnMount,
134 TOnChange,
135 TOnChangeAsync,
136 TOnBlur,
137 TOnBlurAsync,
138 TOnSubmit,
139 TOnSubmitAsync,
140 TOnDynamic,
141 TOnDynamicAsync
142 >,
143 render: renderCallback<
144 TParentData,
145 TName,
146 TData,
147 TOnMount,
148 TOnChange,
149 TOnChangeAsync,
150 TOnBlur,
151 TOnBlurAsync,
152 TOnSubmit,
153 TOnSubmitAsync,
154 TOnDynamic,
155 TOnDynamicAsync,
156 TFormOnMount,
157 TFormOnChange,
158 TFormOnChangeAsync,
159 TFormOnBlur,
160 TFormOnBlurAsync,
161 TFormOnSubmit,
162 TFormOnSubmitAsync,
163 TFormOnDynamic,
164 TFormOnDynamicAsync,
165 TFormOnServer,
166 TSubmitMeta
167 >,
168) => {
169 values: {
170 form: FormApi<
171 TParentData,
172 TFormOnMount,
173 TFormOnChange,
174 TFormOnChangeAsync,
175 TFormOnBlur,
176 TFormOnBlurAsync,
177 TFormOnSubmit,
178 TFormOnSubmitAsync,
179 TFormOnDynamic,
180 TFormOnDynamicAsync,
181 TFormOnServer,
182 TSubmitMeta
183 >
184 options: FieldOptions<
185 TParentData,
186 TName,
187 TData,
188 TOnMount,
189 TOnChange,
190 TOnChangeAsync,
191 TOnBlur,
192 TOnBlurAsync,
193 TOnSubmit,
194 TOnSubmitAsync,
195 TOnDynamic,
196 TOnDynamicAsync
197 >
198 render: renderCallback<
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 TSubmitMeta
222 >
223 }
224}
225β
226export class TanStackFormController<
227 TParentData,
228 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
229 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
230 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
231 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
232 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
233 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
234 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
235 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
236 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
237 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
238 TSubmitMeta,
239> implements ReactiveController {
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β
287 // `TanStackStoreSelector` registers itself as a controller on `host`
288 // and calls `requestUpdate` when its selected value changes. Subscribe
289 // to the form's main store and to `formGroupMetaDerived` so any change
290 // to per-group submission lifecycle / aggregated validity also
291 // triggers a host re-render.
292 new TanStackStoreSelector(host, () => this.api.store)
293 new TanStackStoreSelector(host, () => this.api.formGroupMetaDerived)
294 }
295β
296 hostConnected() {}
297β
298 hostDisconnected() {}
299β
300 field<
301 TName extends DeepKeys<TParentData>,
302 TData extends DeepValue<TParentData, TName>,
303 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
304 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
305 TOnChangeAsync extends
306 | undefined
307 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
308 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
309 TOnBlurAsync extends
310 | undefined
311 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
312 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
313 TOnSubmitAsync extends
314 | undefined
315 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
316 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
317 TOnDynamicAsync extends
318 | undefined
319 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
320 >(
321 fieldConfig: FieldOptions<
322 TParentData,
323 TName,
324 TData,
325 TOnMount,
326 TOnChange,
327 TOnChangeAsync,
328 TOnBlur,
329 TOnBlurAsync,
330 TOnSubmit,
331 TOnSubmitAsync,
332 TOnDynamic,
333 TOnDynamicAsync
334 >,
335 render: renderCallback<
336 TParentData,
337 TName,
338 TData,
339 TOnMount,
340 TOnChange,
341 TOnChangeAsync,
342 TOnBlur,
343 TOnBlurAsync,
344 TOnSubmit,
345 TOnSubmitAsync,
346 TOnDynamic,
347 TOnDynamicAsync,
348 TFormOnMount,
349 TFormOnChange,
350 TFormOnChangeAsync,
351 TFormOnBlur,
352 TFormOnBlurAsync,
353 TFormOnSubmit,
354 TFormOnSubmitAsync,
355 TFormOnDynamic,
356 TFormOnDynamicAsync,
357 TFormOnServer,
358 TSubmitMeta
359 >,
360 ) {
361 return (
362 fieldDirective as unknown as fieldDirectiveType<
363 TParentData,
364 TName,
365 TData,
366 TOnMount,
367 TOnChange,
368 TOnChangeAsync,
369 TOnBlur,
370 TOnBlurAsync,
371 TOnSubmit,
372 TOnSubmitAsync,
373 TOnDynamic,
374 TOnDynamicAsync,
375 TFormOnMount,
376 TFormOnChange,
377 TFormOnChangeAsync,
378 TFormOnBlur,
379 TFormOnBlurAsync,
380 TFormOnSubmit,
381 TFormOnSubmitAsync,
382 TFormOnDynamic,
383 TFormOnDynamicAsync,
384 TFormOnServer,
385 TSubmitMeta
386 >
387 )(this.api, fieldConfig, render)
388 }
389β
390 group<
391 TName extends DeepKeys<TParentData>,
392 TData extends DeepValue<TParentData, TName>,
393 TOnMount extends
394 | undefined
395 | FormGroupValidateOrFn<TParentData, TName, TData>,
396 TOnChange extends
397 | undefined
398 | FormGroupValidateOrFn<TParentData, TName, TData>,
399 TOnChangeAsync extends
400 | undefined
401 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
402 TOnBlur extends
403 | undefined
404 | FormGroupValidateOrFn<TParentData, TName, TData>,
405 TOnBlurAsync extends
406 | undefined
407 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
408 TOnSubmit extends
409 | undefined
410 | FormGroupValidateOrFn<TParentData, TName, TData>,
411 TOnSubmitAsync extends
412 | undefined
413 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
414 TOnDynamic extends
415 | undefined
416 | FormGroupValidateOrFn<TParentData, TName, TData>,
417 TOnDynamicAsync extends
418 | undefined
419 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
420 TGroupSubmitMeta,
421 >(
422 groupConfig: Omit<
423 FormGroupApiOptions<
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 TGroupSubmitMeta,
437 TFormOnMount,
438 TFormOnChange,
439 TFormOnChangeAsync,
440 TFormOnBlur,
441 TFormOnBlurAsync,
442 TFormOnSubmit,
443 TFormOnSubmitAsync,
444 TFormOnDynamic,
445 TFormOnDynamicAsync,
446 TFormOnServer,
447 TSubmitMeta
448 >,
449 'form'
450 >,
451 render: groupRenderCallback<
452 TParentData,
453 TName,
454 TData,
455 TOnMount,
456 TOnChange,
457 TOnChangeAsync,
458 TOnBlur,
459 TOnBlurAsync,
460 TOnSubmit,
461 TOnSubmitAsync,
462 TOnDynamic,
463 TOnDynamicAsync,
464 TGroupSubmitMeta,
465 TFormOnMount,
466 TFormOnChange,
467 TFormOnChangeAsync,
468 TFormOnBlur,
469 TFormOnBlurAsync,
470 TFormOnSubmit,
471 TFormOnSubmitAsync,
472 TFormOnDynamic,
473 TFormOnDynamicAsync,
474 TFormOnServer,
475 TSubmitMeta
476 >,
477 ) {
478 return (
479 formGroupDirective as unknown as formGroupDirectiveType<
480 TParentData,
481 TName,
482 TData,
483 TOnMount,
484 TOnChange,
485 TOnChangeAsync,
486 TOnBlur,
487 TOnBlurAsync,
488 TOnSubmit,
489 TOnSubmitAsync,
490 TOnDynamic,
491 TOnDynamicAsync,
492 TGroupSubmitMeta,
493 TFormOnMount,
494 TFormOnChange,
495 TFormOnChangeAsync,
496 TFormOnBlur,
497 TFormOnBlurAsync,
498 TFormOnSubmit,
499 TFormOnSubmitAsync,
500 TFormOnDynamic,
501 TFormOnDynamicAsync,
502 TFormOnServer,
503 TSubmitMeta
504 >
505 )(this.api, groupConfig, render)
506 }
507}
508β
509class FieldDirective<
510 TParentData,
511 TName extends DeepKeys<TParentData>,
512 TData extends DeepValue<TParentData, TName>,
513 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
514 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
515 TOnChangeAsync extends
516 | undefined
517 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
518 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
519 TOnBlurAsync extends
520 | undefined
521 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
522 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
523 TOnSubmitAsync extends
524 | undefined
525 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
526 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
527 TOnDynamicAsync extends
528 | undefined
529 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
530 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
531 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
532 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
533 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
534 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
535 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
536 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
537 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
538 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
539 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
540 TSubmitMeta,
541> extends AsyncDirective {
542 #registered = false
543 #field?: FieldApi<
544 TParentData,
545 TName,
546 TData,
547 TOnMount,
548 TOnChange,
549 TOnChangeAsync,
550 TOnBlur,
551 TOnBlurAsync,
552 TOnSubmit,
553 TOnSubmitAsync,
554 TOnDynamic,
555 TOnDynamicAsync,
556 TFormOnMount,
557 TFormOnChange,
558 TFormOnChangeAsync,
559 TFormOnBlur,
560 TFormOnBlurAsync,
561 TFormOnSubmit,
562 TFormOnSubmitAsync,
563 TFormOnDynamic,
564 TFormOnDynamicAsync,
565 TFormOnServer,
566 TSubmitMeta
567 >
568 #unmount?: () => void
569β
570 constructor(partInfo: PartInfo) {
571 super(partInfo)
572 if (partInfo.type !== PartType.CHILD) {
573 throw new Error(
574 'The `field` directive must be used in the `child` attribute',
575 )
576 }
577 }
578β
579 update(
580 _: ElementPart,
581 [form, fieldConfig, _render]: Parameters<this['render']>,
582 ) {
583 if (!this.#registered) {
584 if (!this.#field) {
585 const options = { ...fieldConfig, form }
586β
587 this.#field = new FieldApi(options)
588 this.#unmount = this.#field.mount()
589 }
590β
591 this.#registered = true
592 }
593β
594 return this.render(form, fieldConfig, _render)
595 }
596β
597 protected disconnected() {
598 super.disconnected()
599 this.#unmount?.()
600 }
601β
602 protected reconnected() {
603 super.reconnected()
604 if (this.#field) {
605 this.#unmount = this.#field.mount()
606 }
607 }
608β
609 render(
610 _form: FormApi<
611 TParentData,
612 TFormOnMount,
613 TFormOnChange,
614 TFormOnChangeAsync,
615 TFormOnBlur,
616 TFormOnBlurAsync,
617 TFormOnSubmit,
618 TFormOnSubmitAsync,
619 TFormOnDynamic,
620 TFormOnDynamicAsync,
621 TFormOnServer,
622 TSubmitMeta
623 >,
624 _fieldConfig: FieldOptions<
625 TParentData,
626 TName,
627 TData,
628 TOnMount,
629 TOnChange,
630 TOnChangeAsync,
631 TOnBlur,
632 TOnBlurAsync,
633 TOnSubmit,
634 TOnSubmitAsync,
635 TOnDynamic,
636 TOnDynamicAsync
637 >,
638 _renderCallback: renderCallback<
639 TParentData,
640 TName,
641 TData,
642 TOnMount,
643 TOnChange,
644 TOnChangeAsync,
645 TOnBlur,
646 TOnBlurAsync,
647 TOnSubmit,
648 TOnSubmitAsync,
649 TOnDynamic,
650 TOnDynamicAsync,
651 TFormOnMount,
652 TFormOnChange,
653 TFormOnChangeAsync,
654 TFormOnBlur,
655 TFormOnBlurAsync,
656 TFormOnSubmit,
657 TFormOnSubmitAsync,
658 TFormOnDynamic,
659 TFormOnDynamicAsync,
660 TFormOnServer,
661 TSubmitMeta
662 >,
663 ) {
664 if (this.#field) {
665 return _renderCallback(this.#field)
666 }
667 return nothing
668 }
669}
670β
671const fieldDirective = directive(FieldDirective)
672β
673type groupRenderCallback<
674 TParentData,
675 TName extends DeepKeys<TParentData>,
676 TData extends DeepValue<TParentData, TName>,
677 TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
678 TOnChange extends
679 | undefined
680 | FormGroupValidateOrFn<TParentData, TName, TData>,
681 TOnChangeAsync extends
682 | undefined
683 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
684 TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
685 TOnBlurAsync extends
686 | undefined
687 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
688 TOnSubmit extends
689 | undefined
690 | FormGroupValidateOrFn<TParentData, TName, TData>,
691 TOnSubmitAsync extends
692 | undefined
693 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
694 TOnDynamic extends
695 | undefined
696 | FormGroupValidateOrFn<TParentData, TName, TData>,
697 TOnDynamicAsync extends
698 | undefined
699 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
700 TGroupSubmitMeta,
701 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
702 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
703 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
704 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
705 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
706 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
707 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
708 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
709 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
710 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
711 TParentSubmitMeta,
712> = (
713 groupApi: FormGroupApi<
714 TParentData,
715 TName,
716 TData,
717 TOnMount,
718 TOnChange,
719 TOnChangeAsync,
720 TOnBlur,
721 TOnBlurAsync,
722 TOnSubmit,
723 TOnSubmitAsync,
724 TOnDynamic,
725 TOnDynamicAsync,
726 TGroupSubmitMeta,
727 TFormOnMount,
728 TFormOnChange,
729 TFormOnChangeAsync,
730 TFormOnBlur,
731 TFormOnBlurAsync,
732 TFormOnSubmit,
733 TFormOnSubmitAsync,
734 TFormOnDynamic,
735 TFormOnDynamicAsync,
736 TFormOnServer,
737 TParentSubmitMeta
738 >,
739) => unknown
740β
741type formGroupDirectiveType<
742 TParentData,
743 TName extends DeepKeys<TParentData>,
744 TData extends DeepValue<TParentData, TName>,
745 TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
746 TOnChange extends
747 | undefined
748 | FormGroupValidateOrFn<TParentData, TName, TData>,
749 TOnChangeAsync extends
750 | undefined
751 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
752 TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
753 TOnBlurAsync extends
754 | undefined
755 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
756 TOnSubmit extends
757 | undefined
758 | FormGroupValidateOrFn<TParentData, TName, TData>,
759 TOnSubmitAsync extends
760 | undefined
761 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
762 TOnDynamic extends
763 | undefined
764 | FormGroupValidateOrFn<TParentData, TName, TData>,
765 TOnDynamicAsync extends
766 | undefined
767 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
768 TGroupSubmitMeta,
769 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
770 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
771 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
772 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
773 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
774 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
775 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
776 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
777 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
778 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
779 TParentSubmitMeta,
780> = (
781 form: FormApi<
782 TParentData,
783 TFormOnMount,
784 TFormOnChange,
785 TFormOnChangeAsync,
786 TFormOnBlur,
787 TFormOnBlurAsync,
788 TFormOnSubmit,
789 TFormOnSubmitAsync,
790 TFormOnDynamic,
791 TFormOnDynamicAsync,
792 TFormOnServer,
793 TParentSubmitMeta
794 >,
795 options: Omit<
796 FormGroupApiOptions<
797 TParentData,
798 TName,
799 TData,
800 TOnMount,
801 TOnChange,
802 TOnChangeAsync,
803 TOnBlur,
804 TOnBlurAsync,
805 TOnSubmit,
806 TOnSubmitAsync,
807 TOnDynamic,
808 TOnDynamicAsync,
809 TGroupSubmitMeta,
810 TFormOnMount,
811 TFormOnChange,
812 TFormOnChangeAsync,
813 TFormOnBlur,
814 TFormOnBlurAsync,
815 TFormOnSubmit,
816 TFormOnSubmitAsync,
817 TFormOnDynamic,
818 TFormOnDynamicAsync,
819 TFormOnServer,
820 TParentSubmitMeta
821 >,
822 'form'
823 >,
824 render: groupRenderCallback<
825 TParentData,
826 TName,
827 TData,
828 TOnMount,
829 TOnChange,
830 TOnChangeAsync,
831 TOnBlur,
832 TOnBlurAsync,
833 TOnSubmit,
834 TOnSubmitAsync,
835 TOnDynamic,
836 TOnDynamicAsync,
837 TGroupSubmitMeta,
838 TFormOnMount,
839 TFormOnChange,
840 TFormOnChangeAsync,
841 TFormOnBlur,
842 TFormOnBlurAsync,
843 TFormOnSubmit,
844 TFormOnSubmitAsync,
845 TFormOnDynamic,
846 TFormOnDynamicAsync,
847 TFormOnServer,
848 TParentSubmitMeta
849 >,
850) => unknown
851β
852class FormGroupDirective<
853 TParentData,
854 TName extends DeepKeys<TParentData>,
855 TData extends DeepValue<TParentData, TName>,
856 TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
857 TOnChange extends
858 | undefined
859 | FormGroupValidateOrFn<TParentData, TName, TData>,
860 TOnChangeAsync extends
861 | undefined
862 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
863 TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>,
864 TOnBlurAsync extends
865 | undefined
866 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
867 TOnSubmit extends
868 | undefined
869 | FormGroupValidateOrFn<TParentData, TName, TData>,
870 TOnSubmitAsync extends
871 | undefined
872 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
873 TOnDynamic extends
874 | undefined
875 | FormGroupValidateOrFn<TParentData, TName, TData>,
876 TOnDynamicAsync extends
877 | undefined
878 | FormGroupAsyncValidateOrFn<TParentData, TName, TData>,
879 TGroupSubmitMeta,
880 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
881 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
882 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
883 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
884 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
885 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
886 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
887 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
888 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
889 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
890 TParentSubmitMeta,
891> extends AsyncDirective {
892 #registered = false
893 #group?: FormGroupApi<
894 TParentData,
895 TName,
896 TData,
897 TOnMount,
898 TOnChange,
899 TOnChangeAsync,
900 TOnBlur,
901 TOnBlurAsync,
902 TOnSubmit,
903 TOnSubmitAsync,
904 TOnDynamic,
905 TOnDynamicAsync,
906 TGroupSubmitMeta,
907 TFormOnMount,
908 TFormOnChange,
909 TFormOnChangeAsync,
910 TFormOnBlur,
911 TFormOnBlurAsync,
912 TFormOnSubmit,
913 TFormOnSubmitAsync,
914 TFormOnDynamic,
915 TFormOnDynamicAsync,
916 TFormOnServer,
917 TParentSubmitMeta
918 >
919 #unmount?: () => void
920β
921 constructor(partInfo: PartInfo) {
922 super(partInfo)
923 if (partInfo.type !== PartType.CHILD) {
924 throw new Error(
925 'The `group` directive must be used in the `child` attribute',
926 )
927 }
928 }
929β
930 update(
931 _: ElementPart,
932 [form, groupConfig, _render]: Parameters<this['render']>,
933 ) {
934 if (!this.#registered) {
935 if (!this.#group) {
936 const options = { ...groupConfig, form }
937β
938 this.#group = new FormGroupApi(options as never)
939 this.#unmount = this.#group.mount()
940 }
941β
942 this.#registered = true
943 }
944β
945 return this.render(form, groupConfig, _render)
946 }
947β
948 protected disconnected() {
949 super.disconnected()
950 this.#unmount?.()
951 }
952β
953 protected reconnected() {
954 super.reconnected()
955 if (this.#group) {
956 this.#unmount = this.#group.mount()
957 }
958 }
959β
960 render(
961 _form: FormApi<
962 TParentData,
963 TFormOnMount,
964 TFormOnChange,
965 TFormOnChangeAsync,
966 TFormOnBlur,
967 TFormOnBlurAsync,
968 TFormOnSubmit,
969 TFormOnSubmitAsync,
970 TFormOnDynamic,
971 TFormOnDynamicAsync,
972 TFormOnServer,
973 TParentSubmitMeta
974 >,
975 _groupConfig: Omit<
976 FormGroupApiOptions<
977 TParentData,
978 TName,
979 TData,
980 TOnMount,
981 TOnChange,
982 TOnChangeAsync,
983 TOnBlur,
984 TOnBlurAsync,
985 TOnSubmit,
986 TOnSubmitAsync,
987 TOnDynamic,
988 TOnDynamicAsync,
989 TGroupSubmitMeta,
990 TFormOnMount,
991 TFormOnChange,
992 TFormOnChangeAsync,
993 TFormOnBlur,
994 TFormOnBlurAsync,
995 TFormOnSubmit,
996 TFormOnSubmitAsync,
997 TFormOnDynamic,
998 TFormOnDynamicAsync,
999 TFormOnServer,
1000 TParentSubmitMeta
1001 >,
1002 'form'
1003 >,
1004 _renderCallback: groupRenderCallback<
1005 TParentData,
1006 TName,
1007 TData,
1008 TOnMount,
1009 TOnChange,
1010 TOnChangeAsync,
1011 TOnBlur,
1012 TOnBlurAsync,
1013 TOnSubmit,
1014 TOnSubmitAsync,
1015 TOnDynamic,
1016 TOnDynamicAsync,
1017 TGroupSubmitMeta,
1018 TFormOnMount,
1019 TFormOnChange,
1020 TFormOnChangeAsync,
1021 TFormOnBlur,
1022 TFormOnBlurAsync,
1023 TFormOnSubmit,
1024 TFormOnSubmitAsync,
1025 TFormOnDynamic,
1026 TFormOnDynamicAsync,
1027 TFormOnServer,
1028 TParentSubmitMeta
1029 >,
1030 ) {
1031 if (this.#group) {
1032 return _renderCallback(this.#group)
1033 }
1034 return nothing
1035 }
1036}
1037β
1038const formGroupDirective = directive(FormGroupDirective)