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

config.json

988 lines26.4 KB

1{
2 "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
3 "sections": [
4 {
5 "label": "Community Resources",
6 "children": [],
7 "frameworks": []
8 },
9 {
10 "label": "Getting Started",
11 "children": [
12 {
13 "label": "Overview",
14 "to": "overview"
15 },
16 {
17 "label": "Installation",
18 "to": "installation"
19 },
20 {
21 "label": "Migrating from v1",
22 "to": "migrate-from-v1"
23 },
24 {
25 "label": "Philosophy",
26 "to": "philosophy"
27 },
28 {
29 "label": "Comparison",
30 "to": "comparison"
31 },
32 {
33 "label": "TypeScript",
34 "to": "typescript"
35 }
36 ],
37 "frameworks": [
38 {
39 "label": "react",
40 "children": [
41 {
42 "label": "Quick Start",
43 "to": "framework/react/quick-start"
44 }
45 ]
46 },
47 {
48 "label": "preact",
49 "children": [
50 {
51 "label": "Quick Start",
52 "to": "framework/preact/quick-start"
53 }
54 ]
55 },
56 {
57 "label": "vue",
58 "children": [
59 {
60 "label": "Quick Start",
61 "to": "framework/vue/quick-start"
62 }
63 ]
64 },
65 {
66 "label": "angular",
67 "children": [
68 {
69 "label": "Quick Start",
70 "to": "framework/angular/quick-start"
71 }
72 ]
73 },
74 {
75 "label": "solid",
76 "children": [
77 {
78 "label": "Quick Start",
79 "to": "framework/solid/quick-start"
80 }
81 ]
82 },
83 {
84 "label": "lit",
85 "children": [
86 {
87 "label": "Quick Start",
88 "to": "framework/lit/quick-start"
89 }
90 ]
91 },
92 {
93 "label": "svelte",
94 "children": [
95 {
96 "label": "Quick Start",
97 "to": "framework/svelte/quick-start"
98 }
99 ]
100 }
101 ]
102 },
103 {
104 "label": "Guides",
105 "children": [
106 {
107 "label": "Splitting Forms",
108 "to": "splitting-forms"
109 },
110 {
111 "label": "Arrays",
112 "to": "arrays"
113 }
114 ],
115 "frameworks": [
116 {
117 "label": "react",
118 "children": [
119 {
120 "label": "Form Validation",
121 "to": "framework/react/guides/validation"
122 },
123 {
124 "label": "Field Groups",
125 "to": "framework/react/guides/field-groups"
126 },
127 {
128 "label": "Async Initial Values",
129 "to": "framework/react/guides/async-initial-values"
130 },
131 {
132 "label": "UI Libraries",
133 "to": "framework/react/guides/ui-libraries"
134 },
135 {
136 "label": "React Native",
137 "to": "framework/react/guides/react-native"
138 },
139 {
140 "label": "Debugging",
141 "to": "framework/react/guides/debugging"
142 },
143 {
144 "label": "Devtools",
145 "to": "framework/react/guides/devtools"
146 }
147 ]
148 },
149 {
150 "label": "preact",
151 "children": [
152 {
153 "label": "Form Validation",
154 "to": "framework/preact/guides/validation"
155 },
156 {
157 "label": "Async Initial Values",
158 "to": "framework/preact/guides/async-initial-values"
159 },
160 {
161 "label": "UI Libraries",
162 "to": "framework/preact/guides/ui-libraries"
163 },
164 {
165 "label": "Debugging",
166 "to": "framework/preact/guides/debugging"
167 }
168 ]
169 },
170 {
171 "label": "vue",
172 "children": [
173 {
174 "label": "Form Validation",
175 "to": "framework/vue/guides/validation"
176 },
177 {
178 "label": "Async Initial Values",
179 "to": "framework/vue/guides/async-initial-values"
180 },
181 {
182 "label": "UI Libraries",
183 "to": "framework/vue/guides/ui-libraries"
184 },
185 {
186 "label": "Debugging",
187 "to": "framework/vue/guides/debugging"
188 }
189 ]
190 },
191 {
192 "label": "solid",
193 "children": [
194 {
195 "label": "Form Validation",
196 "to": "framework/solid/guides/validation"
197 },
198 {
199 "label": "Async Initial Values",
200 "to": "framework/solid/guides/async-initial-values"
201 },
202 {
203 "label": "UI Libraries",
204 "to": "framework/solid/guides/ui-libraries"
205 },
206 {
207 "label": "Debugging",
208 "to": "framework/solid/guides/debugging"
209 }
210 ]
211 },
212 {
213 "label": "lit",
214 "children": [
215 {
216 "label": "Form Validation",
217 "to": "framework/lit/guides/validation"
218 },
219 {
220 "label": "Async Initial Values",
221 "to": "framework/lit/guides/async-initial-values"
222 },
223 {
224 "label": "UI Libraries",
225 "to": "framework/lit/guides/ui-libraries"
226 },
227 {
228 "label": "Debugging",
229 "to": "framework/lit/guides/debugging"
230 }
231 ]
232 },
233 {
234 "label": "svelte",
235 "children": [
236 {
237 "label": "Form Validation",
238 "to": "framework/svelte/guides/validation"
239 },
240 {
241 "label": "Async Initial Values",
242 "to": "framework/svelte/guides/async-initial-values"
243 },
244 {
245 "label": "UI Libraries",
246 "to": "framework/svelte/guides/ui-libraries"
247 },
248 {
249 "label": "Debugging",
250 "to": "framework/svelte/guides/debugging"
251 }
252 ]
253 }
254 ]
255 },
256 {
257 "label": "Recommended Types",
258 "collapsible": true,
259 "defaultCollapsed": false,
260 "children": [
261 {
262 "label": "AnyFieldApi",
263 "to": "reference/type-aliases/AnyFieldApi"
264 },
265 {
266 "label": "FieldWithValue<TFieldValue>",
267 "to": "reference/type-aliases/FieldWithValue"
268 },
269 {
270 "label": "AnyFormApi",
271 "to": "reference/type-aliases/AnyFormApi"
272 }
273 ],
274 "frameworks": [
275 {
276 "label": "react",
277 "children": [
278 {
279 "label": "AnyReactFormApi",
280 "to": "framework/react/reference/type-aliases/AnyReactFormApi"
281 },
282 {
283 "label": "ReactFormType<TOptions>",
284 "to": "framework/react/reference/type-aliases/ReactFormType"
285 }
286 ]
287 },
288 {
289 "label": "preact",
290 "children": [
291 {
292 "label": "AnyPreactFormApi",
293 "to": "framework/preact/reference/type-aliases/AnyPreactFormApi"
294 },
295 {
296 "label": "PreactFormType<TOptions>",
297 "to": "framework/preact/reference/type-aliases/PreactFormType"
298 }
299 ]
300 },
301 {
302 "label": "vue",
303 "children": [
304 {
305 "label": "AnyVueFormApi",
306 "to": "framework/vue/reference/type-aliases/AnyVueFormApi"
307 },
308 {
309 "label": "VueFormType<TOptions>",
310 "to": "framework/vue/reference/type-aliases/VueFormType"
311 }
312 ]
313 },
314 {
315 "label": "angular",
316 "children": [
317 {
318 "label": "AnyAngularFormApi",
319 "to": "framework/angular/reference/type-aliases/AnyAngularFormApi"
320 },
321 {
322 "label": "AngularFormType<TOptions>",
323 "to": "framework/angular/reference/type-aliases/AngularFormType"
324 }
325 ]
326 },
327 {
328 "label": "solid",
329 "children": [
330 {
331 "label": "AnySolidFormApi",
332 "to": "framework/solid/reference/type-aliases/AnySolidFormApi"
333 },
334 {
335 "label": "SolidFormType<TOptions>",
336 "to": "framework/solid/reference/type-aliases/SolidFormType"
337 }
338 ]
339 },
340 {
341 "label": "lit",
342 "children": [
343 {
344 "label": "AnyLitFormApi",
345 "to": "framework/lit/reference/type-aliases/AnyLitFormApi"
346 },
347 {
348 "label": "LitFormType<TOptions>",
349 "to": "framework/lit/reference/type-aliases/LitFormType"
350 }
351 ]
352 },
353 {
354 "label": "svelte",
355 "children": [
356 {
357 "label": "AnySvelteFormApi",
358 "to": "framework/svelte/reference/type-aliases/AnySvelteFormApi"
359 }
360 ]
361 }
362 ]
363 },
364 {
365 "label": "Form creation",
366 "collapsible": true,
367 "defaultCollapsed": true,
368 "children": [
369 {
370 "label": "formOptions()",
371 "to": "reference/variables/formOptions"
372 },
373 {
374 "label": "formOptions.strictSchema()",
375 "to": "reference/type-aliases/FormOptionsStrictSchemaFn"
376 },
377 {
378 "label": "formOptions.looseSchema()",
379 "to": "reference/type-aliases/FormOptionsLooseSchemaFn"
380 },
381 {
382 "label": "FormOptions",
383 "to": "reference/interfaces/FormOptions"
384 }
385 ],
386 "frameworks": [
387 {
388 "label": "react",
389 "children": [
390 {
391 "label": "useForm()",
392 "to": "framework/react/reference/variables/useForm"
393 }
394 ]
395 },
396 {
397 "label": "preact",
398 "children": [
399 {
400 "label": "useForm()",
401 "to": "framework/preact/reference/variables/useForm"
402 }
403 ]
404 },
405 {
406 "label": "vue",
407 "children": [
408 {
409 "label": "useForm()",
410 "to": "framework/vue/reference/variables/useForm"
411 }
412 ]
413 },
414 {
415 "label": "angular",
416 "children": [
417 {
418 "label": "injectForm()",
419 "to": "framework/angular/reference/functions/injectForm"
420 }
421 ]
422 },
423 {
424 "label": "solid",
425 "children": [
426 {
427 "label": "createForm()",
428 "to": "framework/solid/reference/variables/createForm"
429 }
430 ]
431 },
432 {
433 "label": "lit",
434 "children": [
435 {
436 "label": "TanStackFormController",
437 "to": "framework/lit/reference/classes/TanStackFormController"
438 }
439 ]
440 },
441 {
442 "label": "svelte",
443 "children": [
444 {
445 "label": "createForm()",
446 "to": "framework/svelte/reference/variables/createForm"
447 }
448 ]
449 }
450 ]
451 },
452​
453 {
454 "label": "Form Composition API Reference",
455 "collapsible": true,
456 "defaultCollapsed": true,
457 "children": [],
458 "frameworks": [
459 {
460 "label": "react",
461 "children": [
462 {
463 "label": "createFormHook()",
464 "to": "framework/react/reference/functions/createFormHook"
465 },
466 {
467 "label": "CreateFormHookOptions",
468 "to": "framework/react/reference/interfaces/CreateFormHookOptions"
469 },
470 {
471 "label": "AppFormHookResult",
472 "to": "framework/react/reference/interfaces/AppFormHookResult"
473 },
474 {
475 "label": "FormHookHelpers",
476 "to": "framework/react/reference/interfaces/FormHookHelpers"
477 },
478 {
479 "label": "FieldBrandHelper",
480 "to": "framework/react/reference/interfaces/FieldBrandHelper"
481 },
482 {
483 "label": "FieldComponentHelper",
484 "to": "framework/react/reference/interfaces/FieldComponentHelper"
485 },
486 {
487 "label": "defineFieldGroup()",
488 "to": "framework/react/reference/variables/defineFieldGroup"
489 },
490 {
491 "label": "FieldGroupApi",
492 "to": "framework/react/reference/interfaces/FieldGroupApi"
493 },
494 {
495 "label": "FieldGroupDefinition",
496 "to": "framework/react/reference/interfaces/FieldGroupDefinition"
497 },
498 {
499 "label": "FieldGroupHelper",
500 "to": "reference/interfaces/FieldGroupHelper"
501 }
502 ]
503 }
504 ]
505 },
506 {
507 "label": "FormApi Reference",
508 "collapsible": true,
509 "defaultCollapsed": true,
510 "children": [
511 {
512 "label": "form.setFieldValue()",
513 "to": "reference/type-aliases/SetFieldValueFn"
514 },
515 {
516 "label": "form.getFieldValue()",
517 "to": "reference/type-aliases/GetFieldValueFn"
518 },
519 {
520 "label": "form.resetField()",
521 "to": "reference/type-aliases/ResetFieldFn"
522 },
523 {
524 "label": "form.swapFieldValues()",
525 "to": "reference/type-aliases/SwapFieldValuesFn"
526 },
527 {
528 "label": "form.moveFieldValue()",
529 "to": "reference/type-aliases/MoveFieldValueFn"
530 },
531 {
532 "label": "form.pushFieldValue()",
533 "to": "reference/type-aliases/PushFieldValueFn"
534 },
535 {
536 "label": "form.insertFieldValue()",
537 "to": "reference/type-aliases/InsertFieldValueFn"
538 },
539 {
540 "label": "form.clearFieldValues()",
541 "to": "reference/type-aliases/ClearFieldValuesFn"
542 },
543 {
544 "label": "form.removeFieldValue()",
545 "to": "reference/type-aliases/RemoveFieldValueFn"
546 },
547 {
548 "label": "form.filterFieldValues()",
549 "to": "reference/type-aliases/FilterFieldValuesFn"
550 },
551 {
552 "label": "form.handleSubmit()",
553 "to": "reference/type-aliases/HandleSubmitFn"
554 },
555 {
556 "label": "form.reset()",
557 "to": "reference/type-aliases/ResetFn"
558 },
559 {
560 "label": "FormApi",
561 "to": "reference/interfaces/FormApi"
562 },
563 {
564 "label": "FormOptions",
565 "to": "reference/interfaces/FormOptions"
566 },
567 {
568 "label": "FormState",
569 "to": "reference/interfaces/FormState"
570 },
571 {
572 "label": "FormResetOptions",
573 "to": "reference/interfaces/FormResetOptions"
574 },
575 {
576 "label": "FormSubmitContext",
577 "to": "reference/interfaces/FormSubmitContext"
578 },
579 {
580 "label": "FormSubmitInvalidContext",
581 "to": "reference/interfaces/FormSubmitInvalidContext"
582 }
583 ]
584 },
585 {
586 "label": "Form Listener API Reference",
587 "collapsible": true,
588 "defaultCollapsed": true,
589 "children": [
590 {
591 "label": "FormListener",
592 "to": "reference/interfaces/FormListener"
593 },
594 {
595 "label": "FormListenerTriggers",
596 "to": "reference/type-aliases/FormListenerTriggers"
597 },
598 {
599 "label": "FormListenerFn",
600 "to": "reference/type-aliases/FormListenerFn"
601 },
602 {
603 "label": "FormListenerContext",
604 "to": "reference/interfaces/FormListenerContext"
605 }
606 ]
607 },
608 {
609 "label": "Field Listener API Reference",
610 "collapsible": true,
611 "defaultCollapsed": true,
612 "children": [
613 {
614 "label": "FieldListener",
615 "to": "reference/interfaces/FieldListener"
616 },
617 {
618 "label": "FieldListenerTriggers",
619 "to": "reference/type-aliases/FieldListenerTriggers"
620 },
621 {
622 "label": "FieldListenerFn",
623 "to": "reference/type-aliases/FieldListenerFn"
624 },
625 {
626 "label": "FieldListenerContext",
627 "to": "reference/interfaces/FieldListenerContext"
628 }
629 ]
630 },
631 {
632 "label": "Examples",
633 "children": [],
634 "frameworks": [
635 {
636 "label": "react",
637 "children": [
638 {
639 "label": "Simple",
640 "to": "framework/react/examples/simple"
641 },
642 {
643 "label": "Basic",
644 "to": "framework/react/examples/basic"
645 },
646 {
647 "label": "Form Splitting",
648 "to": "framework/react/examples/basic-splitting-form"
649 },
650 {
651 "label": "Arrays",
652 "to": "framework/react/examples/array"
653 },
654 {
655 "label": "Field Groups",
656 "to": "framework/react/examples/field-groups"
657 },
658 {
659 "label": "Form Composition",
660 "to": "framework/react/examples/large-form"
661 },
662 {
663 "label": "Multi-Step Wizard",
664 "to": "framework/react/examples/multi-step-wizard"
665 },
666 {
667 "label": "Standard Schema",
668 "to": "framework/react/examples/standard-schema"
669 },
670 {
671 "label": "React Compiler",
672 "to": "framework/react/examples/compiler"
673 },
674 {
675 "label": "Expo",
676 "to": "framework/react/examples/expo"
677 }
678 ]
679 },
680 {
681 "label": "preact",
682 "children": [
683 {
684 "label": "Simple",
685 "to": "framework/preact/examples/simple"
686 },
687 {
688 "label": "Basic",
689 "to": "framework/preact/examples/basic"
690 },
691 {
692 "label": "Form Splitting",
693 "to": "framework/preact/examples/basic-splitting-form"
694 },
695 {
696 "label": "Arrays",
697 "to": "framework/preact/examples/array"
698 },
699 {
700 "label": "Field Groups",
701 "to": "framework/preact/examples/field-groups"
702 },
703 {
704 "label": "Form Composition",
705 "to": "framework/preact/examples/large-form"
706 },
707 {
708 "label": "Multi-Step Wizard",
709 "to": "framework/preact/examples/multi-step-wizard"
710 },
711 {
712 "label": "Standard Schema",
713 "to": "framework/preact/examples/standard-schema"
714 }
715 ]
716 },
717 {
718 "label": "vue",
719 "children": [
720 {
721 "label": "Simple",
722 "to": "framework/vue/examples/simple"
723 },
724 {
725 "label": "Arrays",
726 "to": "framework/vue/examples/array"
727 },
728 {
729 "label": "Form Composition",
730 "to": "framework/vue/examples/large-form"
731 },
732 {
733 "label": "Multi-Step Wizard",
734 "to": "framework/vue/examples/multi-step-wizard"
735 },
736 {
737 "label": "Standard Schema",
738 "to": "framework/vue/examples/standard-schema"
739 }
740 ]
741 },
742 {
743 "label": "angular",
744 "children": [
745 {
746 "label": "Simple",
747 "to": "framework/angular/examples/simple"
748 },
749 {
750 "label": "Basic",
751 "to": "framework/angular/examples/basic"
752 },
753 {
754 "label": "Form Splitting",
755 "to": "framework/angular/examples/basic-splitting-form"
756 },
757 {
758 "label": "Arrays",
759 "to": "framework/angular/examples/array"
760 },
761 {
762 "label": "Field Groups",
763 "to": "framework/angular/examples/field-groups"
764 },
765 {
766 "label": "Form Composition",
767 "to": "framework/angular/examples/large-form"
768 },
769 {
770 "label": "Multi-Step Wizard",
771 "to": "framework/angular/examples/multi-step-wizard"
772 },
773 {
774 "label": "Standard Schema",
775 "to": "framework/angular/examples/standard-schema"
776 }
777 ]
778 },
779 {
780 "label": "solid",
781 "children": [
782 {
783 "label": "Simple",
784 "to": "framework/solid/examples/simple"
785 },
786 {
787 "label": "Basic",
788 "to": "framework/solid/examples/basic"
789 },
790 {
791 "label": "Form Splitting",
792 "to": "framework/solid/examples/basic-splitting-form"
793 },
794 {
795 "label": "Arrays",
796 "to": "framework/solid/examples/array"
797 },
798 {
799 "label": "Field Groups",
800 "to": "framework/solid/examples/field-groups"
801 },
802 {
803 "label": "Form Composition",
804 "to": "framework/solid/examples/large-form"
805 },
806 {
807 "label": "Multi-Step Wizard",
808 "to": "framework/solid/examples/multi-step-wizard"
809 },
810 {
811 "label": "Standard Schema",
812 "to": "framework/solid/examples/standard-schema"
813 }
814 ]
815 },
816 {
817 "label": "lit",
818 "children": [
819 {
820 "label": "Simple",
821 "to": "framework/lit/examples/simple"
822 },
823 {
824 "label": "Basic",
825 "to": "framework/lit/examples/basic"
826 },
827 {
828 "label": "Form Splitting",
829 "to": "framework/lit/examples/basic-splitting-form"
830 },
831 {
832 "label": "Arrays",
833 "to": "framework/lit/examples/array"
834 },
835 {
836 "label": "Field Groups",
837 "to": "framework/lit/examples/field-groups"
838 },
839 {
840 "label": "Form Composition",
841 "to": "framework/lit/examples/large-form"
842 },
843 {
844 "label": "Multi-Step Wizard",
845 "to": "framework/lit/examples/multi-step-wizard"
846 },
847 {
848 "label": "Standard Schema",
849 "to": "framework/lit/examples/standard-schema"
850 }
851 ]
852 },
853 {
854 "label": "svelte",
855 "children": [
856 {
857 "label": "Simple",
858 "to": "framework/svelte/examples/simple"
859 },
860 {
861 "label": "Basic",
862 "to": "framework/svelte/examples/basic"
863 },
864 {
865 "label": "Form Splitting",
866 "to": "framework/svelte/examples/basic-splitting-form"
867 },
868 {
869 "label": "Arrays",
870 "to": "framework/svelte/examples/array"
871 },
872 {
873 "label": "Field Groups",
874 "to": "framework/svelte/examples/field-groups"
875 },
876 {
877 "label": "Form Composition",
878 "to": "framework/svelte/examples/large-form"
879 },
880 {
881 "label": "Multi-Step Wizard",
882 "to": "framework/svelte/examples/multi-step-wizard"
883 },
884 {
885 "label": "Standard Schema",
886 "to": "framework/svelte/examples/standard-schema"
887 }
888 ]
889 }
890 ]
891 },
892 {
893 "label": "Framework & Library Integrations",
894 "children": [],
895 "frameworks": [
896 {
897 "label": "react",
898 "children": [
899 {
900 "label": "TanStack Query",
901 "to": "framework/react/examples/query-integration"
902 },
903 {
904 "label": "Next.js",
905 "to": "framework/react/examples/nextjs"
906 },
907 {
908 "label": "Next Server Actions",
909 "to": "framework/react/examples/next-server-actions"
910 },
911 {
912 "label": "Next Server Actions with Zod",
913 "to": "framework/react/examples/next-server-actions-zod"
914 },
915 {
916 "label": "TanStack Start",
917 "to": "framework/react/examples/tanstack-start"
918 }
919 ]
920 },
921 {
922 "label": "preact",
923 "children": [
924 {
925 "label": "TanStack Query",
926 "to": "framework/preact/examples/query-integration"
927 }
928 ]
929 },
930 {
931 "label": "angular",
932 "children": [
933 {
934 "label": "TanStack Query",
935 "to": "framework/angular/examples/query-integration"
936 }
937 ]
938 },
939 {
940 "label": "solid",
941 "children": [
942 {
943 "label": "TanStack Query",
944 "to": "framework/solid/examples/query-integration"
945 }
946 ]
947 },
948 {
949 "label": "lit",
950 "children": [
951 {
952 "label": "TanStack Query",
953 "to": "framework/lit/examples/query-integration"
954 }
955 ]
956 },
957 {
958 "label": "svelte",
959 "children": [
960 {
961 "label": "TanStack Query",
962 "to": "framework/svelte/examples/query-integration"
963 }
964 ]
965 }
966 ]
967 },
968 {
969 "label": "UI Integrations",
970 "children": [],
971 "frameworks": [
972 {
973 "label": "react",
974 "children": [
975 {
976 "label": "DnD Kit",
977 "to": "framework/react/examples/ui-integration-dnd-kit"
978 },
979 {
980 "label": "shadcn/ui",
981 "to": "framework/react/examples/ui-integration-shadcn"
982 }
983 ]
984 }
985 ]
986 }
987 ]