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

config.json

686 lines18.9 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": "SSR/TanStack Start/Next.js",
160 "to": "framework/react/guides/ssr"
161 },
162 {
163 "label": "Debugging",
164 "to": "framework/react/guides/debugging"
165 },
166 {
167 "label": "Devtools",
168 "to": "framework/react/guides/devtools"
169 }
170 ]
171 },
172 {
173 "label": "vue",
174 "children": [
175 {
176 "label": "Basic Concepts",
177 "to": "framework/vue/guides/basic-concepts"
178 },
179 {
180 "label": "Form Validation",
181 "to": "framework/vue/guides/validation"
182 },
183 {
184 "label": "Dynamic Validation",
185 "to": "framework/vue/guides/dynamic-validation"
186 },
187 {
188 "label": "Async Initial Values",
189 "to": "framework/vue/guides/async-initial-values"
190 },
191 {
192 "label": "Arrays",
193 "to": "framework/vue/guides/arrays"
194 },
195 {
196 "label": "Linked Fields",
197 "to": "framework/vue/guides/linked-fields"
198 }
199 ]
200 },
201 {
202 "label": "angular",
203 "children": [
204 {
205 "label": "Basic Concepts",
206 "to": "framework/angular/guides/basic-concepts"
207 },
208 {
209 "label": "Form Validation",
210 "to": "framework/angular/guides/validation"
211 },
212 {
213 "label": "Dynamic Validation",
214 "to": "framework/angular/guides/dynamic-validation"
215 },
216 {
217 "label": "Arrays",
218 "to": "framework/angular/guides/arrays"
219 },
220 {
221 "label": "Form Composition",
222 "to": "framework/angular/guides/form-composition"
223 }
224 ]
225 },
226 {
227 "label": "solid",
228 "children": [
229 {
230 "label": "Basic Concepts",
231 "to": "framework/solid/guides/basic-concepts"
232 },
233 {
234 "label": "Form Validation",
235 "to": "framework/solid/guides/validation"
236 },
237 {
238 "label": "Dynamic Validation",
239 "to": "framework/solid/guides/dynamic-validation"
240 },
241 {
242 "label": "Async Initial Values",
243 "to": "framework/solid/guides/async-initial-values"
244 },
245 {
246 "label": "Arrays",
247 "to": "framework/solid/guides/arrays"
248 },
249 {
250 "label": "Linked Fields",
251 "to": "framework/solid/guides/linked-fields"
252 },
253 {
254 "label": "Form Composition",
255 "to": "framework/solid/guides/form-composition"
256 }
257 ]
258 },
259 {
260 "label": "lit",
261 "children": [
262 {
263 "label": "Basic Concepts",
264 "to": "framework/lit/guides/basic-concepts"
265 },
266 {
267 "label": "Form Validation",
268 "to": "framework/lit/guides/validation"
269 },
270 {
271 "label": "Dynamic Validation",
272 "to": "framework/lit/guides/dynamic-validation"
273 },
274 {
275 "label": "Arrays",
276 "to": "framework/lit/guides/arrays"
277 }
278 ]
279 },
280 {
281 "label": "svelte",
282 "children": [
283 {
284 "label": "Basic Concepts",
285 "to": "framework/svelte/guides/basic-concepts"
286 },
287 {
288 "label": "Form Validation",
289 "to": "framework/svelte/guides/validation"
290 },
291 {
292 "label": "Dynamic Validation",
293 "to": "framework/svelte/guides/dynamic-validation"
294 },
295 {
296 "label": "Async Initial Values",
297 "to": "framework/svelte/guides/async-initial-values"
298 },
299 {
300 "label": "Arrays",
301 "to": "framework/svelte/guides/arrays"
302 },
303 {
304 "label": "Linked Fields",
305 "to": "framework/svelte/guides/linked-fields"
306 }
307 ]
308 }
309 ]
310 },
311 {
312 "collapsible": true,
313 "defaultCollapsed": true,
314 "label": "API Reference",
315 "children": [
316 {
317 "label": "JavaScript Reference",
318 "to": "reference/index"
319 },
320 {
321 "label": "Classes / FieldApi",
322 "to": "reference/classes/FieldApi"
323 },
324 {
325 "label": "Classes / FormApi",
326 "to": "reference/classes/FormApi"
327 },
328 {
329 "label": "Functions / formOptions",
330 "to": "reference/functions/formOptions"
331 },
332 {
333 "label": "Functions / mergeForm",
334 "to": "reference/functions/mergeForm"
335 },
336 {
337 "label": "Interfaces / FieldApiOptions",
338 "to": "reference/interfaces/FieldApiOptions"
339 },
340 {
341 "label": "Interfaces / FieldOptions",
342 "to": "reference/interfaces/FieldOptions"
343 },
344 {
345 "label": "Interfaces / FieldValidators",
346 "to": "reference/interfaces/FieldValidators"
347 },
348 {
349 "label": "Interfaces / FormOptions",
350 "to": "reference/interfaces/FormOptions"
351 },
352 {
353 "label": "Interfaces / FormValidators",
354 "to": "reference/interfaces/FormValidators"
355 },
356 {
357 "label": "Types / DeepKeys",
358 "to": "reference/type-aliases/DeepKeys"
359 },
360 {
361 "label": "Types / DeepValue",
362 "to": "reference/type-aliases/DeepValue"
363 },
364 {
365 "label": "Types / FieldInfo",
366 "to": "reference/type-aliases/FieldInfo"
367 },
368 {
369 "label": "Types / FieldMeta",
370 "to": "reference/type-aliases/FieldMeta"
371 },
372 {
373 "label": "Types / FieldState",
374 "to": "reference/type-aliases/FieldState"
375 },
376 {
377 "label": "Types / BaseFormState",
378 "to": "reference/type-aliases/BaseFormState"
379 },
380 {
381 "label": "Types / DerivedFormState",
382 "to": "reference/type-aliases/DerivedFormState"
383 },
384 {
385 "label": "Types / Updater",
386 "to": "reference/type-aliases/Updater"
387 },
388 {
389 "label": "Types / UpdaterFn",
390 "to": "reference/type-aliases/UpdaterFn"
391 },
392 {
393 "label": "Types / ValidationError",
394 "to": "reference/type-aliases/ValidationError"
395 },
396 {
397 "label": "Types / ValidationMeta",
398 "to": "reference/type-aliases/ValidationMeta"
399 }
400 ],
401 "frameworks": [
402 {
403 "label": "react",
404 "children": [
405 {
406 "label": "React Reference",
407 "to": "framework/react/reference/index"
408 },
409 {
410 "label": "Variables / Field",
411 "to": "framework/react/reference/variables/Field"
412 },
413 {
414 "label": "Functions / useField",
415 "to": "framework/react/reference/functions/useField"
416 },
417 {
418 "label": "Functions / useForm",
419 "to": "framework/react/reference/functions/useForm"
420 },
421 {
422 "label": "Functions / useTransform",
423 "to": "framework/react/reference/functions/useTransform"
424 },
425 {
426 "label": "Types / FieldComponent",
427 "to": "framework/react/reference/type-aliases/FieldComponent"
428 },
429 {
430 "label": "Types / UseField",
431 "to": "framework/react/reference/type-aliases/UseField"
432 }
433 ]
434 },
435 {
436 "label": "vue",
437 "children": [
438 {
439 "label": "Vue Reference",
440 "to": "framework/vue/reference/index"
441 },
442 {
443 "label": "Variables / Field",
444 "to": "framework/vue/reference/variables/Field"
445 },
446 {
447 "label": "Functions / useField",
448 "to": "framework/vue/reference/functions/useField"
449 },
450 {
451 "label": "Functions / useForm",
452 "to": "framework/vue/reference/functions/useForm"
453 },
454 {
455 "label": "Types / FieldComponent",
456 "to": "framework/vue/reference/type-aliases/FieldComponent"
457 },
458 {
459 "label": "Types / UseField",
460 "to": "framework/vue/reference/type-aliases/UseField"
461 }
462 ]
463 },
464 {
465 "label": "solid",
466 "children": [
467 {
468 "label": "Solid Reference",
469 "to": "framework/solid/reference/index"
470 },
471 {
472 "label": "Functions / createField",
473 "to": "framework/solid/reference/functions/createField"
474 },
475 {
476 "label": "Functions / createForm",
477 "to": "framework/solid/reference/functions/createForm"
478 },
479 {
480 "label": "Functions / Field",
481 "to": "framework/solid/reference/functions/Field"
482 },
483 {
484 "label": "Types / CreateField",
485 "to": "framework/solid/reference/type-aliases/CreateField"
486 },
487 {
488 "label": "Types / FieldComponent",
489 "to": "framework/solid/reference/type-aliases/FieldComponent"
490 }
491 ]
492 },
493 {
494 "label": "lit",
495 "children": [
496 {
497 "label": "Lit Reference",
498 "to": "framework/lit/reference/index"
499 },
500 {
501 "label": "Classes / TanStackFormController",
502 "to": "framework/lit/reference/classes/TanStackFormController"
503 }
504 ]
505 },
506 {
507 "label": "angular",
508 "children": [
509 {
510 "label": "Angular Reference",
511 "to": "framework/angular/reference/index"
512 },
513 {
514 "label": "Classes / TanStackField",
515 "to": "framework/angular/reference/classes/TanStackField"
516 },
517 {
518 "label": "Functions / injectForm",
519 "to": "framework/angular/reference/functions/injectForm"
520 },
521 {
522 "label": "Functions / injectStore",
523 "to": "framework/angular/reference/functions/injectStore"
524 }
525 ]
526 }
527 ]
528 },
529 {
530 "label": "Examples",
531 "children": [],
532 "frameworks": [
533 {
534 "label": "react",
535 "children": [
536 {
537 "label": "Simple",
538 "to": "framework/react/examples/simple"
539 },
540 {
541 "label": "Arrays",
542 "to": "framework/react/examples/array"
543 },
544 {
545 "label": "Form Composition",
546 "to": "framework/react/examples/large-form"
547 },
548 {
549 "label": "Dynamic Validation",
550 "to": "framework/react/examples/dynamic"
551 },
552 {
553 "label": "TanStack Query Integration",
554 "to": "framework/react/examples/query-integration"
555 },
556 {
557 "label": "Standard Schema",
558 "to": "framework/react/examples/standard-schema"
559 },
560 {
561 "label": "TanStack Start",
562 "to": "framework/react/examples/tanstack-start"
563 },
564 {
565 "label": "Next Server Actions",
566 "to": "framework/react/examples/next-server-actions"
567 },
568 {
569 "label": "Remix",
570 "to": "framework/react/examples/remix"
571 },
572 {
573 "label": "UI Libraries",
574 "to": "framework/react/examples/ui-libraries"
575 },
576 {
577 "label": "Field Errors From Form Validators",
578 "to": "framework/react/examples/field-errors-from-form-validators"
579 },
580 {
581 "label": "Devtools",
582 "to": "framework/react/examples/devtools"
583 }
584 ]
585 },
586 {
587 "label": "vue",
588 "children": [
589 {
590 "label": "Simple",
591 "to": "framework/vue/examples/simple"
592 },
593 {
594 "label": "Arrays",
595 "to": "framework/vue/examples/array"
596 },
597 {
598 "label": "Standard Schema",
599 "to": "framework/vue/examples/standard-schema"
600 }
601 ]
602 },
603 {
604 "label": "angular",
605 "children": [
606 {
607 "label": "Simple",
608 "to": "framework/angular/examples/simple"
609 },
610 {
611 "label": "Arrays",
612 "to": "framework/angular/examples/array"
613 },
614 {
615 "label": "Form Composition",
616 "to": "framework/angular/examples/large-form"
617 },
618 {
619 "label": "Standard Schema",
620 "to": "framework/angular/examples/standard-schema"
621 }
622 ]
623 },
624 {
625 "label": "solid",
626 "children": [
627 {
628 "label": "Simple",
629 "to": "framework/solid/examples/simple"
630 },
631 {
632 "label": "Arrays",
633 "to": "framework/solid/examples/array"
634 },
635 {
636 "label": "Form Composition",
637 "to": "framework/solid/examples/large-form"
638 },
639 {
640 "label": "Standard Schema",
641 "to": "framework/solid/examples/standard-schema"
642 }
643 ]
644 },
645 {
646 "label": "lit",
647 "children": [
648 {
649 "label": "Simple",
650 "to": "framework/lit/examples/simple"
651 },
652 {
653 "label": "Array",
654 "to": "framework/lit/examples/array"
655 },
656 {
657 "label": "UI Libraries",
658 "to": "framework/lit/examples/ui-libraries"
659 },
660 {
661 "label": "Standard Schema",
662 "to": "framework/lit/examples/standard-schema"
663 }
664 ]
665 },
666 {
667 "label": "svelte",
668 "children": [
669 {
670 "label": "Simple",
671 "to": "framework/svelte/examples/simple"
672 },
673 {
674 "label": "Arrays",
675 "to": "framework/svelte/examples/array"
676 },
677 {
678 "label": "Standard Schema",
679 "to": "framework/svelte/examples/standard-schema"
680 }
681 ]
682 }
683 ]
684 }
685 ]