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

config.json

690 lines19.0 KB

1{
2 "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
3 "docSearch": {
4 "appId": "",
5 "apiKey": "",
6 "indexName": "tanstack-form"
7 },
8 "sections": [
9 {
10 "label": "Community Resources",
11 "children": [],
12 "frameworks": []
13 },
14 {
15 "label": "Getting Started",
16 "children": [
17 {
18 "label": "Overview",
19 "to": "overview"
20 },
21 {
22 "label": "Installation",
23 "to": "installation"
24 },
25 {
26 "label": "Philosophy",
27 "to": "philosophy"
28 },
29 {
30 "label": "Comparison",
31 "to": "comparison"
32 },
33 {
34 "label": "TypeScript",
35 "to": "typescript"
36 }
37 ],
38 "frameworks": [
39 {
40 "label": "react",
41 "children": [
42 {
43 "label": "Quick Start",
44 "to": "framework/react/quick-start"
45 }
46 ]
47 },
48 {
49 "label": "vue",
50 "children": [
51 {
52 "label": "Quick Start",
53 "to": "framework/vue/quick-start"
54 }
55 ]
56 },
57 {
58 "label": "angular",
59 "children": [
60 {
61 "label": "Quick Start",
62 "to": "framework/angular/quick-start"
63 }
64 ]
65 },
66 {
67 "label": "solid",
68 "children": [
69 {
70 "label": "Quick Start",
71 "to": "framework/solid/quick-start"
72 }
73 ]
74 },
75 {
76 "label": "lit",
77 "children": [
78 {
79 "label": "Quick Start",
80 "to": "framework/lit/quick-start"
81 }
82 ]
83 },
84 {
85 "label": "svelte",
86 "children": [
87 {
88 "label": "Quick Start",
89 "to": "framework/svelte/quick-start"
90 }
91 ]
92 }
93 ]
94 },
95 {
96 "label": "Guides",
97 "children": [],
98 "frameworks": [
99 {
100 "label": "react",
101 "children": [
102 {
103 "label": "Basic Concepts",
104 "to": "framework/react/guides/basic-concepts"
105 },
106 {
107 "label": "Form Validation",
108 "to": "framework/react/guides/validation"
109 },
110 {
111 "label": "Dynamic Validation",
112 "to": "framework/react/guides/dynamic-validation"
113 },
114 {
115 "label": "Async Initial Values",
116 "to": "framework/react/guides/async-initial-values"
117 },
118 {
119 "label": "Arrays",
120 "to": "framework/react/guides/arrays"
121 },
122 {
123 "label": "Linked Fields",
124 "to": "framework/react/guides/linked-fields"
125 },
126 {
127 "label": "Reactivity",
128 "to": "framework/react/guides/reactivity"
129 },
130 {
131 "label": "Listeners",
132 "to": "framework/react/guides/listeners"
133 },
134 {
135 "label": "Custom Errors",
136 "to": "framework/react/guides/custom-errors"
137 },
138 {
139 "label": "Submission Handling",
140 "to": "framework/react/guides/submission-handling"
141 },
142 {
143 "label": "UI Libraries",
144 "to": "framework/react/guides/ui-libraries"
145 },
146 {
147 "label": "Focus Management",
148 "to": "framework/react/guides/focus-management"
149 },
150 {
151 "label": "Form Composition",
152 "to": "framework/react/guides/form-composition"
153 },
154 {
155 "label": "React Native",
156 "to": "framework/react/guides/react-native"
157 },
158 {
159 "label": "TanStack Start",
160 "to": "framework/react/guides/tanstack-start"
161 },
162 {
163 "label": "Next.js",
164 "to": "framework/react/guides/nextjs"
165 },
166 {
167 "label": "Remix",
168 "to": "framework/react/guides/remix"
169 },
170 {
171 "label": "Debugging",
172 "to": "framework/react/guides/debugging"
173 },
174 {
175 "label": "Devtools",
176 "to": "framework/react/guides/devtools"
177 }
178 ]
179 },
180 {
181 "label": "vue",
182 "children": [
183 {
184 "label": "Basic Concepts",
185 "to": "framework/vue/guides/basic-concepts"
186 },
187 {
188 "label": "Form Validation",
189 "to": "framework/vue/guides/validation"
190 },
191 {
192 "label": "Dynamic Validation",
193 "to": "framework/vue/guides/dynamic-validation"
194 },
195 {
196 "label": "Async Initial Values",
197 "to": "framework/vue/guides/async-initial-values"
198 },
199 {
200 "label": "Arrays",
201 "to": "framework/vue/guides/arrays"
202 },
203 {
204 "label": "Linked Fields",
205 "to": "framework/vue/guides/linked-fields"
206 }
207 ]
208 },
209 {
210 "label": "angular",
211 "children": [
212 {
213 "label": "Basic Concepts",
214 "to": "framework/angular/guides/basic-concepts"
215 },
216 {
217 "label": "Form Validation",
218 "to": "framework/angular/guides/validation"
219 },
220 {
221 "label": "Dynamic Validation",
222 "to": "framework/angular/guides/dynamic-validation"
223 },
224 {
225 "label": "Arrays",
226 "to": "framework/angular/guides/arrays"
227 },
228 {
229 "label": "Form Composition",
230 "to": "framework/angular/guides/form-composition"
231 }
232 ]
233 },
234 {
235 "label": "solid",
236 "children": [
237 {
238 "label": "Basic Concepts",
239 "to": "framework/solid/guides/basic-concepts"
240 },
241 {
242 "label": "Form Validation",
243 "to": "framework/solid/guides/validation"
244 },
245 {
246 "label": "Dynamic Validation",
247 "to": "framework/solid/guides/dynamic-validation"
248 },
249 {
250 "label": "Async Initial Values",
251 "to": "framework/solid/guides/async-initial-values"
252 },
253 {
254 "label": "Arrays",
255 "to": "framework/solid/guides/arrays"
256 },
257 {
258 "label": "Linked Fields",
259 "to": "framework/solid/guides/linked-fields"
260 },
261 {
262 "label": "Form Composition",
263 "to": "framework/solid/guides/form-composition"
264 }
265 ]
266 },
267 {
268 "label": "lit",
269 "children": [
270 {
271 "label": "Basic Concepts",
272 "to": "framework/lit/guides/basic-concepts"
273 },
274 {
275 "label": "Form Validation",
276 "to": "framework/lit/guides/validation"
277 },
278 {
279 "label": "Dynamic Validation",
280 "to": "framework/lit/guides/dynamic-validation"
281 },
282 {
283 "label": "Arrays",
284 "to": "framework/lit/guides/arrays"
285 }
286 ]
287 },
288 {
289 "label": "svelte",
290 "children": [
291 {
292 "label": "Basic Concepts",
293 "to": "framework/svelte/guides/basic-concepts"
294 },
295 {
296 "label": "Form Validation",
297 "to": "framework/svelte/guides/validation"
298 },
299 {
300 "label": "Dynamic Validation",
301 "to": "framework/svelte/guides/dynamic-validation"
302 },
303 {
304 "label": "Async Initial Values",
305 "to": "framework/svelte/guides/async-initial-values"
306 },
307 {
308 "label": "Arrays",
309 "to": "framework/svelte/guides/arrays"
310 },
311 {
312 "label": "Linked Fields",
313 "to": "framework/svelte/guides/linked-fields"
314 }
315 ]
316 }
317 ]
318 },
319 {
320 "collapsible": true,
321 "defaultCollapsed": true,
322 "label": "API Reference",
323 "children": [
324 {
325 "label": "JavaScript Reference",
326 "to": "reference/index"
327 },
328 {
329 "label": "Classes / FieldApi",
330 "to": "reference/classes/FieldApi"
331 },
332 {
333 "label": "Classes / FormApi",
334 "to": "reference/classes/FormApi"
335 },
336 {
337 "label": "Functions / formOptions",
338 "to": "reference/functions/formOptions"
339 },
340 {
341 "label": "Functions / mergeForm",
342 "to": "reference/functions/mergeForm"
343 },
344 {
345 "label": "Interfaces / FieldApiOptions",
346 "to": "reference/interfaces/FieldApiOptions"
347 },
348 {
349 "label": "Interfaces / FieldOptions",
350 "to": "reference/interfaces/FieldOptions"
351 },
352 {
353 "label": "Interfaces / FieldValidators",
354 "to": "reference/interfaces/FieldValidators"
355 },
356 {
357 "label": "Interfaces / FormOptions",
358 "to": "reference/interfaces/FormOptions"
359 },
360 {
361 "label": "Interfaces / FormValidators",
362 "to": "reference/interfaces/FormValidators"
363 },
364 {
365 "label": "Types / DeepKeys",
366 "to": "reference/type-aliases/DeepKeys"
367 },
368 {
369 "label": "Types / DeepValue",
370 "to": "reference/type-aliases/DeepValue"
371 },
372 {
373 "label": "Types / FieldInfo",
374 "to": "reference/type-aliases/FieldInfo"
375 },
376 {
377 "label": "Types / FieldMeta",
378 "to": "reference/type-aliases/FieldMeta"
379 },
380 {
381 "label": "Types / FieldState",
382 "to": "reference/type-aliases/FieldState"
383 },
384 {
385 "label": "Types / BaseFormState",
386 "to": "reference/type-aliases/BaseFormState"
387 },
388 {
389 "label": "Types / DerivedFormState",
390 "to": "reference/type-aliases/DerivedFormState"
391 },
392 {
393 "label": "Types / Updater",
394 "to": "reference/type-aliases/Updater"
395 },
396 {
397 "label": "Types / UpdaterFn",
398 "to": "reference/type-aliases/UpdaterFn"
399 },
400 {
401 "label": "Types / ValidationError",
402 "to": "reference/type-aliases/ValidationError"
403 },
404 {
405 "label": "Types / ValidationMeta",
406 "to": "reference/type-aliases/ValidationMeta"
407 }
408 ],
409 "frameworks": [
410 {
411 "label": "react",
412 "children": [
413 {
414 "label": "React Reference",
415 "to": "framework/react/reference/index"
416 },
417 {
418 "label": "Variables / Field",
419 "to": "framework/react/reference/variables/Field"
420 },
421 {
422 "label": "Functions / useField",
423 "to": "framework/react/reference/functions/useField"
424 },
425 {
426 "label": "Functions / useForm",
427 "to": "framework/react/reference/functions/useForm"
428 },
429 {
430 "label": "Types / FieldComponent",
431 "to": "framework/react/reference/type-aliases/FieldComponent"
432 },
433 {
434 "label": "Types / UseField",
435 "to": "framework/react/reference/type-aliases/UseField"
436 }
437 ]
438 },
439 {
440 "label": "vue",
441 "children": [
442 {
443 "label": "Vue Reference",
444 "to": "framework/vue/reference/index"
445 },
446 {
447 "label": "Variables / Field",
448 "to": "framework/vue/reference/variables/Field"
449 },
450 {
451 "label": "Functions / useField",
452 "to": "framework/vue/reference/functions/useField"
453 },
454 {
455 "label": "Functions / useForm",
456 "to": "framework/vue/reference/functions/useForm"
457 },
458 {
459 "label": "Types / FieldComponent",
460 "to": "framework/vue/reference/type-aliases/FieldComponent"
461 },
462 {
463 "label": "Types / UseField",
464 "to": "framework/vue/reference/type-aliases/UseField"
465 }
466 ]
467 },
468 {
469 "label": "solid",
470 "children": [
471 {
472 "label": "Solid Reference",
473 "to": "framework/solid/reference/index"
474 },
475 {
476 "label": "Functions / createField",
477 "to": "framework/solid/reference/functions/createField"
478 },
479 {
480 "label": "Functions / createForm",
481 "to": "framework/solid/reference/functions/createForm"
482 },
483 {
484 "label": "Functions / Field",
485 "to": "framework/solid/reference/functions/Field"
486 },
487 {
488 "label": "Types / CreateField",
489 "to": "framework/solid/reference/type-aliases/CreateField"
490 },
491 {
492 "label": "Types / FieldComponent",
493 "to": "framework/solid/reference/type-aliases/FieldComponent"
494 }
495 ]
496 },
497 {
498 "label": "lit",
499 "children": [
500 {
501 "label": "Lit Reference",
502 "to": "framework/lit/reference/index"
503 },
504 {
505 "label": "Classes / TanStackFormController",
506 "to": "framework/lit/reference/classes/TanStackFormController"
507 }
508 ]
509 },
510 {
511 "label": "angular",
512 "children": [
513 {
514 "label": "Angular Reference",
515 "to": "framework/angular/reference/index"
516 },
517 {
518 "label": "Classes / TanStackField",
519 "to": "framework/angular/reference/classes/TanStackField"
520 },
521 {
522 "label": "Functions / injectForm",
523 "to": "framework/angular/reference/functions/injectForm"
524 },
525 {
526 "label": "Functions / injectStore",
527 "to": "framework/angular/reference/functions/injectStore"
528 }
529 ]
530 }
531 ]
532 },
533 {
534 "label": "Examples",
535 "children": [],
536 "frameworks": [
537 {
538 "label": "react",
539 "children": [
540 {
541 "label": "Simple",
542 "to": "framework/react/examples/simple"
543 },
544 {
545 "label": "Arrays",
546 "to": "framework/react/examples/array"
547 },
548 {
549 "label": "Form Composition",
550 "to": "framework/react/examples/large-form"
551 },
552 {
553 "label": "Dynamic Validation",
554 "to": "framework/react/examples/dynamic"
555 },
556 {
557 "label": "TanStack Query Integration",
558 "to": "framework/react/examples/query-integration"
559 },
560 {
561 "label": "Standard Schema",
562 "to": "framework/react/examples/standard-schema"
563 },
564 {
565 "label": "TanStack Start",
566 "to": "framework/react/examples/tanstack-start"
567 },
568 {
569 "label": "Next Server Actions",
570 "to": "framework/react/examples/next-server-actions"
571 },
572 {
573 "label": "Remix",
574 "to": "framework/react/examples/remix"
575 },
576 {
577 "label": "UI Libraries",
578 "to": "framework/react/examples/ui-libraries"
579 },
580 {
581 "label": "Field Errors From Form Validators",
582 "to": "framework/react/examples/field-errors-from-form-validators"
583 },
584 {
585 "label": "Devtools",
586 "to": "framework/react/examples/devtools"
587 }
588 ]
589 },
590 {
591 "label": "vue",
592 "children": [
593 {
594 "label": "Simple",
595 "to": "framework/vue/examples/simple"
596 },
597 {
598 "label": "Arrays",
599 "to": "framework/vue/examples/array"
600 },
601 {
602 "label": "Standard Schema",
603 "to": "framework/vue/examples/standard-schema"
604 }
605 ]
606 },
607 {
608 "label": "angular",
609 "children": [
610 {
611 "label": "Simple",
612 "to": "framework/angular/examples/simple"
613 },
614 {
615 "label": "Arrays",
616 "to": "framework/angular/examples/array"
617 },
618 {
619 "label": "Form Composition",
620 "to": "framework/angular/examples/large-form"
621 },
622 {
623 "label": "Standard Schema",
624 "to": "framework/angular/examples/standard-schema"
625 }
626 ]
627 },
628 {
629 "label": "solid",
630 "children": [
631 {
632 "label": "Simple",
633 "to": "framework/solid/examples/simple"
634 },
635 {
636 "label": "Arrays",
637 "to": "framework/solid/examples/array"
638 },
639 {
640 "label": "Form Composition",
641 "to": "framework/solid/examples/large-form"
642 },
643 {
644 "label": "Standard Schema",
645 "to": "framework/solid/examples/standard-schema"
646 }
647 ]
648 },
649 {
650 "label": "lit",
651 "children": [
652 {
653 "label": "Simple",
654 "to": "framework/lit/examples/simple"
655 },
656 {
657 "label": "Array",
658 "to": "framework/lit/examples/array"
659 },
660 {
661 "label": "UI Libraries",
662 "to": "framework/lit/examples/ui-libraries"
663 },
664 {
665 "label": "Standard Schema",
666 "to": "framework/lit/examples/standard-schema"
667 }
668 ]
669 },
670 {
671 "label": "svelte",
672 "children": [
673 {
674 "label": "Simple",
675 "to": "framework/svelte/examples/simple"
676 },
677 {
678 "label": "Arrays",
679 "to": "framework/svelte/examples/array"
680 },
681 {
682 "label": "Standard Schema",
683 "to": "framework/svelte/examples/standard-schema"
684 }
685 ]
686 }
687 ]
688 }
689 ]