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": "ZFKQRGRQA8",
5 "apiKey": "93e0b83eb0b5af4549b6bf47f90af3f7",
6 "indexName": "tanstack-query"
7 },
8 "sections": [
9 {
10 "label": "Getting Started",
11 "children": [],
12 "frameworks": [
13 {
14 "label": "react",
15 "children": [
16 {
17 "label": "Overview",
18 "to": "framework/react/overview"
19 },
20 {
21 "label": "Installation",
22 "to": "framework/react/installation"
23 },
24 {
25 "label": "Quick Start",
26 "to": "framework/react/quick-start"
27 },
28 {
29 "label": "Devtools",
30 "to": "framework/react/devtools"
31 },
32 {
33 "label": "Videos & Talks",
34 "to": "framework/react/videos"
35 },
36 {
37 "label": "Comparison",
38 "to": "framework/react/comparison"
39 },
40 {
41 "label": "TypeScript",
42 "to": "framework/react/typescript"
43 },
44 {
45 "label": "GraphQL",
46 "to": "framework/react/graphql"
47 },
48 {
49 "label": "React Native",
50 "to": "framework/react/react-native"
51 }
52 ]
53 },
54 {
55 "label": "solid",
56 "children": [
57 {
58 "label": "Overview",
59 "to": "framework/solid/overview"
60 }
61 ]
62 },
63 {
64 "label": "vue",
65 "children": [
66 {
67 "label": "Overview",
68 "to": "framework/vue/overview"
69 },
70 {
71 "label": "Installation",
72 "to": "framework/vue/installation"
73 },
74 {
75 "label": "Quick Start",
76 "to": "framework/vue/quick-start"
77 },
78 {
79 "label": "Devtools",
80 "to": "framework/vue/devtools"
81 },
82 {
83 "label": "TypeScript",
84 "to": "framework/vue/typescript"
85 },
86 {
87 "label": "GraphQL",
88 "to": "framework/vue/graphql"
89 }
90 ]
91 },
92 {
93 "label": "svelte",
94 "children": [
95 {
96 "label": "Overview",
97 "to": "framework/svelte/overview"
98 },
99 {
100 "label": "Installation",
101 "to": "framework/svelte/installation"
102 },
103 {
104 "label": "SSR & SvelteKit",
105 "to": "framework/svelte/ssr"
106 },
107 {
108 "label": "Reactivity",
109 "to": "framework/svelte/reactivity"
110 }
111 ]
112 }
113 ]
114 },
115 {
116 "label": "Guides & Concepts",
117 "children": [],
118 "frameworks": [
119 {
120 "label": "react",
121 "children": [
122 {
123 "label": "Important Defaults",
124 "to": "framework/react/guides/important-defaults"
125 },
126 {
127 "label": "Queries",
128 "to": "framework/react/guides/queries"
129 },
130 {
131 "label": "Query Keys",
132 "to": "framework/react/guides/query-keys"
133 },
134 {
135 "label": "Query Functions",
136 "to": "framework/react/guides/query-functions"
137 },
138 {
139 "label": "Network Mode",
140 "to": "framework/react/guides/network-mode"
141 },
142 {
143 "label": "Parallel Queries",
144 "to": "framework/react/guides/parallel-queries"
145 },
146 {
147 "label": "Dependent Queries",
148 "to": "framework/react/guides/dependent-queries"
149 },
150 {
151 "label": "Background Fetching Indicators",
152 "to": "framework/react/guides/background-fetching-indicators"
153 },
154 {
155 "label": "Window Focus Refetching",
156 "to": "framework/react/guides/window-focus-refetching"
157 },
158 {
159 "label": "Disabling/Pausing Queries",
160 "to": "framework/react/guides/disabling-queries"
161 },
162 {
163 "label": "Query Retries",
164 "to": "framework/react/guides/query-retries"
165 },
166 {
167 "label": "Paginated Queries",
168 "to": "framework/react/guides/paginated-queries"
169 },
170 {
171 "label": "Infinite Queries",
172 "to": "framework/react/guides/infinite-queries"
173 },
174 {
175 "label": "Initial Query Data",
176 "to": "framework/react/guides/initial-query-data"
177 },
178 {
179 "label": "Placeholder Query Data",
180 "to": "framework/react/guides/placeholder-query-data"
181 },
182 {
183 "label": "Prefetching",
184 "to": "framework/react/guides/prefetching"
185 },
186 {
187 "label": "Mutations",
188 "to": "framework/react/guides/mutations"
189 },
190 {
191 "label": "Query Invalidation",
192 "to": "framework/react/guides/query-invalidation"
193 },
194 {
195 "label": "Invalidation from Mutations",
196 "to": "framework/react/guides/invalidations-from-mutations"
197 },
198 {
199 "label": "Updates from Mutation Responses",
200 "to": "framework/react/guides/updates-from-mutation-responses"
201 },
202 {
203 "label": "Optimistic Updates",
204 "to": "framework/react/guides/optimistic-updates"
205 },
206 {
207 "label": "Query Cancellation",
208 "to": "framework/react/guides/query-cancellation"
209 },
210 {
211 "label": "Scroll Restoration",
212 "to": "framework/react/guides/scroll-restoration"
213 },
214 {
215 "label": "Filters",
216 "to": "framework/react/guides/filters"
217 },
218 {
219 "label": "SSR & Next.js",
220 "to": "framework/react/guides/ssr"
221 },
222 {
223 "label": "Caching",
224 "to": "framework/react/guides/caching"
225 },
226 {
227 "label": "Default Query Fn",
228 "to": "framework/react/guides/default-query-function"
229 },
230 {
231 "label": "Suspense",
232 "to": "framework/react/guides/suspense"
233 },
234 {
235 "label": "Custom Logger",
236 "to": "framework/react/guides/custom-logger"
237 },
238 {
239 "label": "Testing",
240 "to": "framework/react/guides/testing"
241 },
242 {
243 "label": "Does this replace [Redux, MobX, etc]?",
244 "to": "framework/react/guides/does-this-replace-client-state"
245 },
246 {
247 "label": "Migrating to React Query 3",
248 "to": "framework/react/guides/migrating-to-react-query-3"
249 },
250 {
251 "label": "Migrating to React Query 4",
252 "to": "framework/react/guides/migrating-to-react-query-4"
253 }
254 ]
255 },
256 {
257 "label": "vue",
258 "children": [
259 {
260 "label": "Important Defaults",
261 "to": "framework/vue/guides/important-defaults"
262 },
263 {
264 "label": "Queries",
265 "to": "framework/vue/guides/queries"
266 },
267 {
268 "label": "Query Keys",
269 "to": "framework/vue/guides/query-keys"
270 },
271 {
272 "label": "Query Functions",
273 "to": "framework/vue/guides/query-functions"
274 },
275 {
276 "label": "Network Mode",
277 "to": "framework/vue/guides/network-mode"
278 },
279 {
280 "label": "Parallel Queries",
281 "to": "framework/vue/guides/parallel-queries"
282 },
283 {
284 "label": "Dependent Queries",
285 "to": "framework/vue/guides/dependent-queries"
286 },
287 {
288 "label": "Background Fetching Indicators",
289 "to": "framework/vue/guides/background-fetching-indicators"
290 },
291 {
292 "label": "Window Focus Refetching",
293 "to": "framework/vue/guides/window-focus-refetching"
294 },
295 {
296 "label": "Disabling/Pausing Queries",
297 "to": "framework/vue/guides/disabling-queries"
298 },
299 {
300 "label": "Query Retries",
301 "to": "framework/vue/guides/query-retries"
302 },
303 {
304 "label": "Paginated Queries",
305 "to": "framework/vue/guides/paginated-queries"
306 },
307 {
308 "label": "Infinite Queries",
309 "to": "framework/vue/guides/infinite-queries"
310 },
311 {
312 "label": "Initial Query Data",
313 "to": "framework/vue/guides/initial-query-data"
314 },
315 {
316 "label": "Placeholder Query Data",
317 "to": "framework/vue/guides/placeholder-query-data"
318 },
319 {
320 "label": "Prefetching",
321 "to": "framework/vue/guides/prefetching"
322 },
323 {
324 "label": "Mutations",
325 "to": "framework/vue/guides/mutations"
326 },
327 {
328 "label": "Query Invalidation",
329 "to": "framework/vue/guides/query-invalidation"
330 },
331 {
332 "label": "Invalidation from Mutations",
333 "to": "framework/vue/guides/invalidations-from-mutations"
334 },
335 {
336 "label": "Updates from Mutation",
337 "to": "framework/vue/guides/updates-from-mutation-responses"
338 },
339 {
340 "label": "Optimistic Updates",
341 "to": "framework/vue/guides/optimistic-updates"
342 },
343 {
344 "label": "Query Cancellation",
345 "to": "framework/vue/guides/query-cancellation"
346 },
347 {
348 "label": "Scroll Restoration",
349 "to": "framework/vue/guides/scroll-restoration"
350 },
351 {
352 "label": "Filters",
353 "to": "framework/vue/guides/filters"
354 },
355 {
356 "label": "SSR & Nuxt",
357 "to": "framework/vue/guides/ssr"
358 },
359 {
360 "label": "Caching",
361 "to": "framework/vue/guides/caching"
362 },
363 {
364 "label": "Default Query Fn",
365 "to": "framework/vue/guides/default-query-function"
366 },
367 {
368 "label": "Suspense",
369 "to": "framework/vue/guides/suspense"
370 },
371 {
372 "label": "Custom Logger",
373 "to": "framework/vue/guides/custom-logger"
374 },
375 {
376 "label": "Custom Client",
377 "to": "framework/vue/guides/custom-client"
378 },
379 {
380 "label": "Does this replace [Vuex, Pinia]?",
381 "to": "framework/vue/guides/does-this-replace-client-state"
382 }
383 ]
384 }
385 ]
386 },
387 {
388 "label": "Community Resources",
389 "children": [],
390 "frameworks": [
391 {
392 "label": "react",
393 "children": [
394 {
395 "label": "TkDodo's Blog",
396 "to": "framework/react/community/tkdodos-blog"
397 },
398 {
399 "label": "Batching Requests",
400 "to": "framework/react/community/batching-requests-using-bathshit"
401 },
402 {
403 "label": "Query Key Factory",
404 "to": "framework/react/community/lukemorales-query-key-factory"
405 },
406 {
407 "label": "React Query Kit",
408 "to": "framework/react/community/liaoliao666-react-query-kit"
409 },
410 {
411 "label": "Angular Query",
412 "to": "framework/react/community/angular-query"
413 },
414 {
415 "label": "Suspensive React Query",
416 "to": "framework/react/community/suspensive-react-query"
417 }
418 ]
419 },
420 {
421 "label": "vue",
422 "children": [
423 {
424 "label": "TkDodo's Blog",
425 "to": "framework/vue/community/tkdodos-blog"
426 },
427 {
428 "label": "Query Key Factory",
429 "to": "framework/vue/community/lukemorales-query-key-factory"
430 }
431 ]
432 }
433 ]
434 },
435 {
436 "label": "API Reference",
437 "children": [
438 {
439 "label": "QueryClient",
440 "to": "reference/QueryClient"
441 },
442 {
443 "label": "QueryCache",
444 "to": "reference/QueryCache"
445 },
446 {
447 "label": "MutationCache",
448 "to": "reference/MutationCache"
449 },
450 {
451 "label": "QueryObserver",
452 "to": "reference/QueryObserver"
453 },
454 {
455 "label": "InfiniteQueryObserver",
456 "to": "reference/InfiniteQueryObserver"
457 },
458 {
459 "label": "QueriesObserver",
460 "to": "reference/QueriesObserver"
461 },
462 {
463 "label": "focusManager",
464 "to": "reference/focusManager"
465 },
466 {
467 "label": "onlineManager",
468 "to": "reference/onlineManager"
469 }
470 ],
471 "frameworks": [
472 {
473 "label": "react",
474 "children": [
475 {
476 "label": "useQuery",
477 "to": "framework/react/reference/useQuery"
478 },
479 {
480 "label": "useQueries",
481 "to": "framework/react/reference/useQueries"
482 },
483 {
484 "label": "useInfiniteQuery",
485 "to": "framework/react/reference/useInfiniteQuery"
486 },
487 {
488 "label": "useMutation",
489 "to": "framework/react/reference/useMutation"
490 },
491 {
492 "label": "useIsFetching",
493 "to": "framework/react/reference/useIsFetching"
494 },
495 {
496 "label": "useIsMutating",
497 "to": "framework/react/reference/useIsMutating"
498 },
499 {
500 "label": "QueryClientProvider",
501 "to": "framework/react/reference/QueryClientProvider"
502 },
503 {
504 "label": "useQueryClient",
505 "to": "framework/react/reference/useQueryClient"
506 },
507 {
508 "label": "QueryErrorResetBoundary",
509 "to": "framework/react/reference/QueryErrorResetBoundary"
510 },
511 {
512 "label": "useQueryErrorResetBoundary",
513 "to": "framework/react/reference/useQueryErrorResetBoundary"
514 },
515 {
516 "label": "hydration",
517 "to": "framework/react/reference/hydration"
518 }
519 ]
520 },
521 {
522 "label": "vue",
523 "children": [
524 {
525 "label": "useQuery",
526 "to": "framework/vue/reference/useQuery"
527 },
528 {
529 "label": "useQueries",
530 "to": "framework/vue/reference/useQueries"
531 },
532 {
533 "label": "useInfiniteQuery",
534 "to": "framework/vue/reference/useInfiniteQuery"
535 },
536 {
537 "label": "useMutation",
538 "to": "framework/vue/reference/useMutation"
539 },
540 {
541 "label": "useIsFetching",
542 "to": "framework/vue/reference/useIsFetching"
543 },
544 {
545 "label": "useIsMutating",
546 "to": "framework/vue/reference/useIsMutating"
547 },
548 {
549 "label": "useQueryClient",
550 "to": "framework/vue/reference/useQueryClient"
551 },
552 {
553 "label": "hydration",
554 "to": "framework/vue/reference/hydration"
555 }
556 ]
557 }
558 ]
559 },
560 {
561 "label": "ESLint",
562 "children": [
563 {
564 "label": "ESLint Plugin Query",
565 "to": "eslint/eslint-plugin-query"
566 },
567 {
568 "label": "Exhaustive Deps",
569 "to": "eslint/exhaustive-deps"
570 },
571 {
572 "label": "No deprecated options",
573 "to": "eslint/no-deprecated-options"
574 },
575 {
576 "label": "Prefer object syntax",
577 "to": "eslint/prefer-query-object-syntax"
578 },
579 {
580 "label": "Stable Query Client",
581 "to": "eslint/stable-query-client"
582 }
583 ]
584 },
585 {
586 "label": "Plugins",
587 "children": [],
588 "frameworks": [
589 {
590 "label": "react",
591 "children": [
592 {
593 "label": "persistQueryClient",
594 "to": "framework/react/plugins/persistQueryClient"
595 },
596 {
597 "label": "createSyncStoragePersister",
598 "to": "framework/react/plugins/createSyncStoragePersister"
599 },
600 {
601 "label": "createAsyncStoragePersister",
602 "to": "framework/react/plugins/createAsyncStoragePersister"
603 },
604 {
605 "label": "broadcastQueryClient (Experimental)",
606 "to": "framework/react/plugins/broadcastQueryClient"
607 }
608 ]
609 }
610 ]
611 },
612 {
613 "label": "Examples",
614 "children": [],
615 "frameworks": [
616 {
617 "label": "react",
618 "children": [
619 {
620 "label": "Simple",
621 "to": "framework/react/examples/simple"
622 },
623 {
624 "label": "Basic",
625 "to": "framework/react/examples/basic"
626 },
627 {
628 "label": "Basic w/ GraphQL-Request",
629 "to": "framework/react/examples/basic-graphql-request"
630 },
631 {
632 "label": "Auto Refetching / Polling / Realtime",
633 "to": "framework/react/examples/auto-refetching"
634 },
635 {
636 "label": "Optimistic Updates in TypeScript",
637 "to": "framework/react/examples/optimistic-updates-typescript"
638 },
639 {
640 "label": "Pagination",
641 "to": "framework/react/examples/pagination"
642 },
643 {
644 "label": "Load-More & Infinite Scroll",
645 "to": "framework/react/examples/load-more-infinite-scroll"
646 },
647 {
648 "label": "Suspense",
649 "to": "framework/react/examples/suspense"
650 },
651 {
652 "label": "Default Query Function",
653 "to": "framework/react/examples/default-query-function"
654 },
655 {
656 "label": "Playground",
657 "to": "framework/react/examples/playground"
658 },
659 {
660 "label": "Prefetching",
661 "to": "framework/react/examples/prefetching"
662 },
663 {
664 "label": "Star Wars",
665 "to": "framework/react/examples/star-wars"
666 },
667 {
668 "label": "Rick And Morty",
669 "to": "framework/react/examples/rick-morty"
670 },
671 {
672 "label": "Next.js",
673 "to": "framework/react/examples/nextjs"
674 },
675 {
676 "label": "React Native",
677 "to": "framework/react/examples/react-native"
678 },
679 {
680 "label": "React Router",
681 "to": "framework/react/examples/react-router"
682 },
683 {
684 "label": "Offline Queries and Mutations",
685 "to": "framework/react/examples/offline"
686 },
687 {
688 "label": "Algolia",
689 "to": "framework/react/examples/algolia"
690 }
691 ]
692 },
693 {
694 "label": "vue",
695 "children": [
696 {
697 "label": "Basic",
698 "to": "framework/vue/examples/basic"
699 },
700 {
701 "label": "Vue 2.6",
702 "to": "framework/vue/examples/2.6-basic"
703 },
704 {
705 "label": "Nuxt 3",
706 "to": "framework/vue/examples/nuxt3"
707 },
708 {
709 "label": "Persister",
710 "to": "framework/vue/examples/persister"
711 }
712 ]
713 },
714 {
715 "label": "svelte",
716 "children": [
717 {
718 "label": "Simple",
719 "to": "framework/svelte/examples/simple"
720 },
721 {
722 "label": "Basic",
723 "to": "framework/svelte/examples/basic"
724 },
725 {
726 "label": "Auto Refetching / Polling / Realtime",
727 "to": "framework/svelte/examples/auto-refetching"
728 },
729 {
730 "label": "SSR",
731 "to": "framework/svelte/examples/ssr"
732 },
733 {
734 "label": "Optimistic Updates in TypeScript",
735 "to": "framework/svelte/examples/optimistic-updates-typescript"
736 },
737 {
738 "label": "Playground",
739 "to": "framework/svelte/examples/playground"
740 },
741 {
742 "label": "Star Wars",
743 "to": "framework/svelte/examples/star-wars"
744 },
745 {
746 "label": "Infinite Queries",
747 "to": "framework/svelte/examples/load-more-infinite-scroll"
748 }
749 ]
750 }
751 ]
752 }
753 ],
754 "users": [
755 "Google",
756 "Walmart",
757 "Facebook",
758 "PayPal",
759 "Amazon",
760 "American Express",
761 "Microsoft",
762 "Target",
763 "Ebay",
764 "Autodesk",
765 "CarFAX",
766 "Docusign",
767 "HP",
768 "MLB",
769 "Volvo",
770 "Ocado",
771 "UPC.ch",
772 "EFI.com",
773 "ReactBricks",
774 "Nozzle.io",
775 "Uber"
776 ]
777}