Open History to see the last commit
1{
2 "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
3 "docSearch": {
4 "appId": "FQ0DQ6MA3C",
5 "apiKey": "8264730bab8a9b7fa6a0c85761d7a3fe",
6 "indexName": "tanstack"
7 },
8 "sections": [
9 {
10 "label": "Getting Started",
11 "children": [
12 {
13 "label": "Overview",
14 "to": "overview"
15 },
16 {
17 "label": "Quick Start",
18 "to": "quick-start"
19 },
20 {
21 "label": "Devtools",
22 "to": "devtools"
23 },
24 {
25 "label": "Decisions on DX",
26 "to": "decisions-on-dx"
27 },
28 {
29 "label": "Comparison",
30 "to": "comparison"
31 },
32 {
33 "label": "Frequently Asked Questions",
34 "to": "faq"
35 }
36 ],
37 "frameworks": [
38 {
39 "label": "react",
40 "children": []
41 },
42 {
43 "label": "solid",
44 "children": []
45 }
46 ]
47 },
48 {
49 "label": "Installation Guides",
50 "children": [
51 {
52 "label": "Manual Setup",
53 "to": "installation/manual"
54 },
55 {
56 "label": "Vite",
57 "to": "installation/with-vite"
58 },
59 {
60 "label": "Rspack/Rsbuild",
61 "to": "installation/with-rspack"
62 },
63 {
64 "label": "Webpack",
65 "to": "installation/with-webpack"
66 },
67 {
68 "label": "Esbuild",
69 "to": "installation/with-esbuild"
70 },
71 {
72 "label": "Router CLI",
73 "to": "installation/with-router-cli"
74 }
75 ],
76 "frameworks": [
77 {
78 "label": "react",
79 "children": [
80 {
81 "label": "Migrate from React Router",
82 "to": "installation/migrate-from-react-router"
83 },
84 {
85 "label": "Migrate from React Location",
86 "to": "installation/migrate-from-react-location"
87 }
88 ]
89 },
90 {
91 "label": "solid",
92 "children": []
93 }
94 ]
95 },
96 {
97 "label": "Core Routing",
98 "children": [
99 {
100 "label": "Routing Concepts",
101 "to": "routing/routing-concepts"
102 },
103 {
104 "label": "Route Trees",
105 "to": "routing/route-trees"
106 },
107 {
108 "label": "Route Matching",
109 "to": "routing/route-matching"
110 },
111 {
112 "label": "File-Based Routing",
113 "to": "routing/file-based-routing"
114 },
115 {
116 "label": "Virtual File Routes",
117 "to": "routing/virtual-file-routes"
118 },
119 {
120 "label": "Code-Based Routing",
121 "to": "routing/code-based-routing"
122 },
123 {
124 "label": "File Naming Conventions",
125 "to": "routing/file-naming-conventions"
126 },
127 {
128 "label": "URL Rewrites",
129 "to": "guide/url-rewrites"
130 }
131 ],
132 "frameworks": [
133 {
134 "label": "react",
135 "children": []
136 },
137 {
138 "label": "solid",
139 "children": []
140 }
141 ]
142 },
143 {
144 "label": "Navigation & URL State",
145 "collapsible": true,
146 "children": [
147 {
148 "label": "Navigation",
149 "to": "guide/navigation"
150 },
151 {
152 "label": "Link Options",
153 "to": "guide/link-options"
154 },
155 {
156 "label": "Custom Links",
157 "to": "guide/custom-link"
158 },
159 {
160 "label": "Path Params",
161 "to": "guide/path-params"
162 },
163 {
164 "label": "Search Params",
165 "to": "guide/search-params"
166 },
167 {
168 "label": "Custom Search Param Serialization",
169 "to": "guide/custom-search-param-serialization"
170 },
171 {
172 "label": "Route Masking",
173 "to": "guide/route-masking"
174 },
175 {
176 "label": "Navigation Blocking",
177 "to": "guide/navigation-blocking"
178 },
179 {
180 "label": "History Types",
181 "to": "guide/history-types"
182 },
183 {
184 "label": "Scroll Restoration",
185 "to": "guide/scroll-restoration"
186 },
187 {
188 "label": "Internationalization",
189 "to": "guide/internationalization-i18n"
190 }
191 ],
192 "frameworks": [
193 {
194 "label": "react",
195 "children": []
196 },
197 {
198 "label": "solid",
199 "children": []
200 }
201 ]
202 },
203 {
204 "label": "Data & Rendering",
205 "collapsible": true,
206 "children": [
207 {
208 "label": "Code Splitting",
209 "to": "guide/code-splitting"
210 },
211 {
212 "label": "Automatic Code Splitting",
213 "to": "guide/automatic-code-splitting"
214 },
215 {
216 "label": "Data Loading",
217 "to": "guide/data-loading"
218 },
219 {
220 "label": "Deferred Data Loading",
221 "to": "guide/deferred-data-loading"
222 },
223 {
224 "label": "External Data Loading",
225 "to": "guide/external-data-loading"
226 },
227 {
228 "label": "Data Mutations",
229 "to": "guide/data-mutations"
230 },
231 {
232 "label": "Preloading",
233 "to": "guide/preloading"
234 },
235 {
236 "label": "Document Head Management",
237 "to": "guide/document-head-management"
238 },
239 {
240 "label": "SSR",
241 "to": "guide/ssr"
242 },
243 {
244 "label": "Render Optimizations",
245 "to": "guide/render-optimizations"
246 }
247 ],
248 "frameworks": [
249 {
250 "label": "react",
251 "children": []
252 },
253 {
254 "label": "solid",
255 "children": []
256 }
257 ]
258 },
259 {
260 "label": "Router Configuration",
261 "collapsible": true,
262 "children": [
263 {
264 "label": "Creating a Router",
265 "to": "guide/creating-a-router"
266 },
267 {
268 "label": "Outlets",
269 "to": "guide/outlets"
270 },
271 {
272 "label": "Router Events",
273 "to": "guide/router-events"
274 },
275 {
276 "label": "Type Safety",
277 "to": "guide/type-safety"
278 },
279 {
280 "label": "Type Utilities",
281 "to": "guide/type-utilities"
282 },
283 {
284 "label": "Router Context",
285 "to": "guide/router-context"
286 },
287 {
288 "label": "Not Found Errors",
289 "to": "guide/not-found-errors"
290 },
291 {
292 "label": "Authenticated Routes",
293 "to": "guide/authenticated-routes"
294 },
295 {
296 "label": "Static Route Data",
297 "to": "guide/static-route-data"
298 }
299 ],
300 "frameworks": [
301 {
302 "label": "react",
303 "children": []
304 },
305 {
306 "label": "solid",
307 "children": []
308 }
309 ]
310 },
311 {
312 "label": "API",
313 "children": [
314 {
315 "label": "Router",
316 "to": "api/router"
317 },
318 {
319 "label": "File-Based Routing",
320 "to": "api/file-based-routing"
321 }
322 ],
323 "frameworks": [
324 {
325 "label": "react",
326 "children": []
327 },
328 {
329 "label": "solid",
330 "children": []
331 }
332 ]
333 },
334 {
335 "label": "Integrations",
336 "children": [
337 {
338 "label": "TanStack Query",
339 "to": "integrations/query"
340 }
341 ],
342 "frameworks": [
343 {
344 "label": "react",
345 "children": []
346 },
347 {
348 "label": "solid",
349 "children": []
350 }
351 ]
352 },
353 {
354 "label": "ESLint",
355 "children": [
356 {
357 "label": "ESLint Plugin Router",
358 "to": "eslint/eslint-plugin-router"
359 },
360 {
361 "label": "Create Route Property Order",
362 "to": "eslint/create-route-property-order"
363 }
364 ]
365 },
366 {
367 "label": "Router Examples",
368 "children": [],
369 "frameworks": [
370 {
371 "label": "react",
372 "children": [
373 {
374 "label": "Quickstart (file-based)",
375 "to": "framework/react/examples/quickstart-file-based"
376 },
377 {
378 "label": "Quickstart (code-based)",
379 "to": "framework/react/examples/quickstart"
380 },
381 {
382 "label": "Basic (file-based)",
383 "to": "framework/react/examples/basic-file-based"
384 },
385 {
386 "label": "Basic (code-based)",
387 "to": "framework/react/examples/basic"
388 },
389 {
390 "label": "Basic + React Query (file-based)",
391 "to": "framework/react/examples/basic-react-query-file-based"
392 },
393 {
394 "label": "Basic + React Query (code-based)",
395 "to": "framework/react/examples/basic-react-query"
396 },
397 {
398 "label": "Basic + SSR (file-based)",
399 "to": "framework/react/examples/basic-ssr-file-based"
400 },
401 {
402 "label": "Basic + SSR Streaming (file-based)",
403 "to": "framework/react/examples/basic-ssr-streaming-file-based"
404 },
405 {
406 "label": "Kitchen Sink (file-based)",
407 "to": "framework/react/examples/kitchen-sink-file-based"
408 },
409 {
410 "label": "Kitchen Sink (code-based)",
411 "to": "framework/react/examples/kitchen-sink"
412 },
413 {
414 "label": "Kitchen Sink + React Query (file-based)",
415 "to": "framework/react/examples/kitchen-sink-react-query-file-based"
416 },
417 {
418 "label": "Kitchen Sink + React Query (code-based)",
419 "to": "framework/react/examples/kitchen-sink-react-query"
420 },
421 {
422 "label": "Location Masking",
423 "to": "framework/react/examples/location-masking"
424 },
425 {
426 "label": "Authenticated Routes",
427 "to": "framework/react/examples/authenticated-routes"
428 },
429 {
430 "label": "Scroll Restoration",
431 "to": "framework/react/examples/scroll-restoration"
432 },
433 {
434 "label": "Deferred Data",
435 "to": "framework/react/examples/deferred-data"
436 },
437 {
438 "label": "Navigation Blocking",
439 "to": "framework/react/examples/navigation-blocking"
440 },
441 {
442 "label": "View Transitions",
443 "to": "framework/react/examples/view-transitions"
444 },
445 {
446 "label": "Framer Motion",
447 "to": "framework/react/examples/with-framer-motion"
448 },
449 {
450 "label": "With tRPC",
451 "to": "framework/react/examples/with-trpc"
452 },
453 {
454 "label": "With tRPC + React Query",
455 "to": "framework/react/examples/with-trpc-react-query"
456 },
457 {
458 "label": "Monorepo basic",
459 "to": "framework/react/examples/router-monorepo-simple"
460 },
461 {
462 "label": "Monorepo basic (with lazy loading)",
463 "to": "framework/react/examples/router-monorepo-simple-lazy"
464 },
465 {
466 "label": "Monorepo with React Query",
467 "to": "framework/react/examples/router-monorepo-react-query"
468 }
469 ]
470 },
471 {
472 "label": "solid",
473 "children": [
474 {
475 "label": "Quickstart (file-based)",
476 "to": "framework/solid/examples/quickstart-file-based"
477 },
478 {
479 "label": "Quickstart (code-based)",
480 "to": "framework/solid/examples/quickstart"
481 },
482 {
483 "label": "Basic (file-based)",
484 "to": "framework/solid/examples/basic-file-based"
485 },
486 {
487 "label": "Basic + Solid Query (file-based)",
488 "to": "framework/solid/examples/basic-solid-query-file-based"
489 },
490 {
491 "label": "Basic + Solid Query (code-based)",
492 "to": "framework/solid/examples/basic-solid-query"
493 },
494 {
495 "label": "Basic + SSR (file-based)",
496 "to": "framework/solid/examples/basic-ssr-file-based"
497 },
498 {
499 "label": "Basic + SSR Streaming (file-based)",
500 "to": "framework/solid/examples/basic-ssr-streaming-file-based"
501 },
502 {
503 "label": "Kitchen Sink (code-based)",
504 "to": "framework/solid/examples/kitchen-sink"
505 },
506 {
507 "label": "Kitchen Sink (file-based)",
508 "to": "framework/solid/examples/kitchen-sink-file-based"
509 },
510 {
511 "label": "Kitchen Sink + Solid Query (file-based)",
512 "to": "framework/solid/examples/kitchen-sink-solid-query-file-based"
513 },
514 {
515 "label": "Kitchen Sink + Solid Query (code-based)",
516 "to": "framework/solid/examples/kitchen-sink-solid-query"
517 },
518 {
519 "label": "Location Masking",
520 "to": "framework/solid/examples/location-masking"
521 },
522 {
523 "label": "Authenticated Routes",
524 "to": "framework/solid/examples/authenticated-routes"
525 },
526 {
527 "label": "Scroll Restoration",
528 "to": "framework/solid/examples/scroll-restoration"
529 },
530 {
531 "label": "Deferred Data",
532 "to": "framework/solid/examples/deferred-data"
533 },
534 {
535 "label": "Navigation Blocking",
536 "to": "framework/solid/examples/navigation-blocking"
537 },
538 {
539 "label": "View Transitions",
540 "to": "framework/solid/examples/view-transitions"
541 },
542 {
543 "label": "Framer Motion",
544 "to": "framework/solid/examples/with-framer-motion"
545 },
546 {
547 "label": "With tRPC",
548 "to": "framework/solid/examples/with-trpc"
549 },
550 {
551 "label": "Monorepo basic",
552 "to": "framework/solid/examples/router-monorepo-simple"
553 },
554 {
555 "label": "Monorepo basic (with lazy loading)",
556 "to": "framework/solid/examples/router-monorepo-simple-lazy"
557 },
558 {
559 "label": "Monorepo with Solid Query",
560 "to": "framework/solid/examples/router-monorepo-solid-query"
561 }
562 ]
563 }
564 ]
565 }
566 ]
567}