0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
Commit graph

156 commits

Author SHA1 Message Date
Wonsuk Choi
c9c00015ef
docs(examples): add router and framework suffix to 'docs/config.json' labels and 'package.json' names (#12458)
* docs(examples): add router and framework suffix to 'docs/config.json' labels and 'package.json' names

* docs(examples): distinguish Next.js App/Pages Router and Nuxt/SolidStart major versions in example labels and names
2026-10-30 01:50:34 +09:00
Wonsuk Choi
127cbf9922
docs(examples/lit): add 'auto-refetching', 'infinite-query-with-max-pages', 'load-more-infinite-scroll', 'optimistic-updates' and 'prefetching' examples (#12456)
* docs(examples/lit): add 'auto-refetching', 'infinite-query-with-max-pages', 'load-more-infinite-scroll', 'optimistic-updates' and 'prefetching' examples

* fix(examples/lit/auto-refetching): encode 'add' query parameter with 'encodeURIComponent'
2026-10-30 01:04:56 +09:00
Wonsuk Choi
8de245ba16
docs(examples/lit): add 'batching' and 'offline' examples (#12455) 2026-10-30 00:14:24 +09:00
Wonsuk Choi
af78ace5c4
docs(examples/lit): add 'star-wars' and 'rick-morty' examples with '@lit-labs/router' (#12453) 2026-10-29 19:27:22 +09:00
Wonsuk Choi
744cb2cb2e
docs(examples/lit): add 'simple', 'basic-graphql-request', 'default-query-function', 'playground', 'algolia' and 'chat' examples (#12451) 2026-10-29 17:27:14 +09:00
Wonsuk Choi
52d7fd34a5
docs(examples/vue): replace 'nuxt3' with 'simple-nuxt3' and 'simple-nuxt4' examples and include them in the workspace (#12448) 2026-10-29 14:06:04 +09:00
Wonsuk Choi
fdb7692e83
docs(examples/vue): add 'pagination', 'auto-refetching', 'load-more-infinite-scroll', 'infinite-query-with-max-pages', 'prefetching' and 'optimistic-updates' examples with Nuxt (#12445) 2026-10-29 12:08:10 +09:00
Wonsuk Choi
ff41bb21c6
docs(examples/vue): add 'suspense', 'batching' and 'offline' examples (#12444) 2026-10-29 11:38:33 +09:00
Wonsuk Choi
5aa553880a
docs(examples/vue): add 'star-wars', 'rick-morty' and 'vue-router' examples (#12439) 2026-10-29 10:25:46 +09:00
Wonsuk Choi
e423d30ae0
docs(examples/vue): add 'basic-graphql-request', 'default-query-function', 'devtools-panel', 'playground', 'shadow-dom', 'algolia' and 'chat' examples (#12438) 2026-10-28 19:18:28 +09:00
Wonsuk Choi
b2ed952200
docs(examples/svelte): add 'pagination', 'prefetching' and 'infinite-query-with-max-pages' examples (#12432) 2026-10-28 15:35:46 +09:00
Wonsuk Choi
2a7e3cc5e0
docs(examples/svelte): add 'batching' and 'offline' examples (#12431) 2026-10-28 14:51:48 +09:00
Wonsuk Choi
e8770f5d21
docs(examples/svelte): add 'rick-morty' and 'sveltekit' examples (#12430) 2026-10-28 13:57:37 +09:00
Wonsuk Choi
9d1e2de1d7
docs(examples/svelte): add 'basic-graphql-request', 'default-query-function', 'shadow-dom', 'algolia' and 'chat' examples (#12429)
* docs(examples/svelte): add 'basic-graphql-request', 'default-query-function', 'shadow-dom', 'algolia' and 'chat' examples

* docs(examples/svelte): declare '$props()' with 'let' in the new examples

* docs(examples/svelte/{basic-graphql-request,default-query-function}): prevent the hash navigation on the post links
2026-10-28 13:27:02 +09:00
Wonsuk Choi
158a5868cd
docs(examples/solid): add 'pagination', 'auto-refetching', 'prefetching' and 'optimistic-updates' examples with SolidStart (#12428)
* docs(examples/solid): add 'pagination', 'auto-refetching', 'prefetching' and 'optimistic-updates' examples with SolidStart

* docs(examples/solid/{pagination,optimistic-updates}): keep query errors inside the 'ErrorBoundary'
2026-10-28 12:16:21 +09:00
Wonsuk Choi
e54f6ff5e3
docs(examples/solid): add 'suspense' and 'batching' examples (#12426) 2026-10-28 11:05:04 +09:00
Wonsuk Choi
ce2febdacb
docs(examples/solid): add 'star-wars', 'rick-morty' and 'solid-router' examples (#12424) 2026-10-28 10:32:33 +09:00
Wonsuk Choi
35ee52aca8
docs(examples/solid): add 'devtools-panel', 'shadow-dom', 'playground', 'algolia' and 'chat' examples (#12423) 2026-10-28 10:11:54 +09:00
Wonsuk Choi
ab2a7198bb
docs(preact): add a streaming section to the SSR guide and an 'ssr-streaming' example (#12412) 2026-10-27 10:38:25 +09:00
Wonsuk Choi
479a8dbf3c
docs(examples/preact/ssr): add ssr example with prefetching, dependent queries and error handling (#12407)
* docs(examples/preact/ssr): add ssr example

* docs(examples/preact/ssr): prefetch a dependent query and treat the posts as critical content
2026-10-27 00:41:37 +09:00
Wonsuk Choi
7a2bc3c95b
docs(examples/preact/optimistic-updates): add optimistic-updates example (#12404) 2026-10-27 00:16:00 +09:00
Wonsuk Choi
8af7af6f11
docs(examples/preact): add 'auto-refetching', 'pagination', 'load-more-infinite-scroll', 'infinite-query-with-max-pages' and 'prefetching' examples (#12403)
* docs(examples/preact): add 'auto-refetching', 'pagination', 'load-more-infinite-scroll', 'infinite-query-with-max-pages' and 'prefetching' examples

* docs(examples/preact/auto-refetching): share the mocked list across tabs through 'localStorage'
2026-10-27 00:09:32 +09:00
Wonsuk Choi
bb11f3cc82
docs(examples/preact): add 'suspense' and 'batching' examples (#12402) 2026-10-26 23:23:26 +09:00
Wonsuk Choi
b484ddd573
docs(examples/preact): add 'star-wars', 'rick-morty' and 'offline' examples (#12401)
* docs(examples/preact): add 'suspense', 'star-wars' and 'rick-morty' examples

* ci: apply automated fixes

* docs(examples/preact): move 'suspense' out and add 'offline' example

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-10-26 23:15:51 +09:00
Wonsuk Choi
a075333e4c
docs(examples/preact): add 'shadow-dom' and 'devtools-panel' examples (#12399) 2026-10-26 22:33:32 +09:00
Wonsuk Choi
bf50a62dd0
docs(examples/preact): add 'basic-graphql-request', 'default-query-function', 'playground', 'algolia' and 'chat' examples (#12397)
* docs(examples/preact/basic-graphql-request): add basic-graphql-request example

* docs(examples/preact): add 'default-query-function', 'playground', 'algolia' and 'chat' examples
2026-10-26 22:16:25 +09:00
Wonsuk Choi
edbceae5d3
docs(examples/preact/basic): add basic example (#12387) 2026-10-26 21:25:39 +09:00
Wonsuk Choi
67eaf77279
docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers (#12206)
* docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers

* docs(lit/guides/testing): add the imports to the controller and fake timers examples so each can be used as its own file
2026-10-20 19:58:57 +09:00
Wonsuk Choi
4c56e9eea5
docs(svelte/testing): add the testing guide with '$effect.root' and Svelte Testing Library (#12205)
* docs(svelte/testing): add the testing guide with '$effect.root' and Svelte Testing Library

* docs(svelte/testing): clean up the effect root in 'finally' and add the 'withEffectRoot' helper variant

* docs(svelte/testing): explain that testing a function on its own needs a 'QueryClient' accessor and point to the component approach otherwise

* docs(svelte/testing): share the query with 'queryOptions' instead of a wrapper function that takes a 'QueryClient' accessor
2026-10-20 16:32:49 +09:00
Wonsuk Choi
e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00
Wonsuk Choi
309508612a
docs(vue-query): add JSDoc and generate reference docs with TypeDoc (#11378)
* docs(vue-query): add JSDoc across the package

* docs(vue-query): generate reference docs with TypeDoc

* docs(config): register vue-query TypeDoc reference pages

* docs(vue-query): preserve dehydrate/hydrate option docs and fix reference links

* docs(config): reorder vue-query reference nav to list 'Functions' first

* docs(config): reorder vue-query 'Functions' entries to match react/preact grouping

* docs(vue-query): restore Suspense guide link and 'placeholderData' behavior note lost in TypeDoc migration

* docs(vue-query): correct JSDoc accuracy issues and reactivity bugs

* docs(vue-query): fix invalidateQueries example that invalidated every query, add whole-options getter example

* docs(vue-query): add examples for the mutationOptions and useInfiniteQuery getter overloads

* docs(vue-query): add react-parity examples for select, skipToken, keepPreviousData, optimistic updates, and infinite scroll

* docs(vue-query): add queryOptions select typing example to useQueries

* docs(vue-query): disconnect IntersectionObserver on unmount, drop non-null assertion in skipToken examples

* docs(vue-query): add 'skipToken' factory example to 'queryOptions'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'useQuery'/'useInfiniteQuery'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'QueryOptions' type JSDoc

* docs(vue-query): fix reversed claim that 'queryKey' entries can't be reactive getters
2026-09-05 13:29:11 +09:00
Jooyoung Shin
ec3f992cbf
docs(preact-query): add 'Suspense' and 'Testing' guides (#11377)
docs(preact-query): add Suspense and Testing guides

The Preact docs had no counterpart for the React "Suspense" and
"Testing" guides even though `@tanstack/preact-query` ships the
suspense hooks and `QueryErrorResetBoundary`.

Follow the existing Preact docs convention: reference the React guide
via `ref:` + `replace:` and override only the React-specific sections
(`preact/compat` Suspense, an error boundary built on `useErrorBoundary`,
`@testing-library/preact`). The React guides only gain the section
markers needed for the overrides; their wording is unchanged.
2026-09-04 15:11:20 +09:00
Wonsuk Choi
26e24a07ff
docs(config): reorder solid-query 'Functions' entries to match react grouping (#11386) 2026-09-04 10:26:25 +09:00
Wonsuk Choi
2c5ba585ac
docs(preact-query): add 'Server Rendering & Hydration' guide (#11380)
* docs(preact-query): add 'Server Rendering & Hydration' guide

* docs(preact-query): add 'serializeData'/'deserializeData' to SSR guide
2026-09-03 21:48:01 +09:00
Wonsuk Choi
de8ab4db3e
docs(solid-query): add JSDoc and generate reference docs with TypeDoc (#11369)
* docs(solid-query): add JSDoc across the package

* docs(solid-query): generate reference docs with TypeDoc

* docs(config): register solid-query TypeDoc reference pages

* docs(solid-query): correct inaccurate JSDoc statements flagged in review
2026-09-03 10:19:23 +09:00
Wonsuk Choi
4c568a28c8
docs(react-query): generate reference docs with TypeDoc (#11366)
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs

* docs(react-query): generate reference docs with TypeDoc

* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy

* docs(solid-query): apply solid's callback call form to inlined reference examples

* docs(react-query): correct inaccurate JSDoc statements flagged in review

* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review

* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review

* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does

* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
2026-09-02 16:06:54 +09:00
Wonsuk Choi
16b6671374
docs(config): register all TypeDoc-generated reference pages with category-prefixed labels (#11268) 2026-08-24 10:58:23 +09:00
Dominik Dorfmeister 🔮
bf7ae20fed
docs(example): batching (#11008)
* docs(example): dataloader

* use tanstack pacer instead of dataloader

* add staleTime

* switch to useAsyncBatchedCallback

* Revert "switch to useAsyncBatchedCallback"

This reverts commit 4d408daa63.

* fix: use PromiseWithResolvers

* add batching example to docs
2026-08-20 11:25:31 +02:00
Lucas127128
b8e35598ef
docs(svelte-query/quick-start): Add quick start docs (#11227)
* Add quick start docs in svelte query

* Apply suggestions from code review

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

* ci: apply automated fixes

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-18 21:21:21 +02:00
Guilherme Rabelo
baa256c0d2
docs(examples): add Next.js App Router optimistic updates example (#10997)
* feat(examples): add Next.js App Router optimistic updates example

* refactor(examples/nextjs-app-optimistic-updates): apply post-review corrections

* refactor(examples/nextjs-app-optimistic-updates): apply post-review corrections

* update deps

* ref: remove other optimistic update examples

* ci: apply automated fixes

---------

Co-authored-by: Guilherme Rabelo <T0006742@randon.com.br>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-18 09:57:04 +02:00
Wonsuk Choi
4446c3a1cb
docs(config.json): add 'Preact Reference' index entry to API Reference sidebar (#11198) 2026-08-17 00:08:58 +09:00
Wonsuk Choi
3f9d11b814
docs(config.json): drop redundant 'Functions /' prefix from svelte and angular sidebar labels (#11193) 2026-08-16 19:11:49 +09:00
Wonsuk Choi
9ad475e0ac
docs(config.json): register missing svelte API reference functions in sidebar (#11192) 2026-08-16 18:49:06 +09:00
Wonsuk Choi
7d4b6ed52e
docs(config.json): register missing angular API reference functions in sidebar (#11191) 2026-08-16 18:25:52 +09:00
Poetry Of Code
661c1afe79
docs(preact): add polling guide (#10991)
* docs(svelte): replace deprecated isLoading with isPending in overview

`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.

Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(preact): add missing polling guide

The Polling guide existed for React, Vue, Solid, and Angular but was
missing from the Preact docs. Added the ref stub and wired it into
the nav config between Window Focus Refetching and Disabling Queries,
matching the ordering used by all other frameworks.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-27 15:45:37 +02:00
Gaurav
4082894509
feat: lit query adapter
* feat lit-query: add initial lit-query package

* remove internal docs from initial PR

* fix review issues

* align scripts with monorepo Nx targets and use workspace:* for query-core

* feat(lit-query): fix type inference and monorepo integration

  - Fix createQueriesController tuple type inference with recursive types
  - Add DataTag support to queryOptions
  - Fix build config and vitest custom-condition resolution
  - Fix example install scripts for standalone bootstrap

* fix(lit-query): polish package validation and examples

* ci: apply automated fixes

* lit-query: preserve provider handshake ordering in BaseController

* Update .changeset/lemon-memes-divide.md

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

* removing prettier config from adapter, so that global config from the monorepo is used

* removed the package local format scripts so formatting stays centralized at the monorepo root

* removing like other adapters keep build and test:build as separate targets

* Compared against the other adapters and removed the lit-query-only aliases/gates, keeping the standard Nx target names so root CI can pick them up consistently

* package:check has been removed. The CJS smoke check is still needed because lit-query publishes custom CJS output/types

* fix(lit-query): align lit examples and integration with monorepo conventions

* chore(lit-query): clean up stale package checks

* fix(lit-query): address review feedback for lit examples and lifecycle tests

* chore: fix lockfile

* fix: add customCondition

* docs(lit-query): add Lit docs and generated reference

* docs(lit-query): fix Lit docs review comment and align examples

---------

Co-authored-by: gauravchugh <gauravchugh@servicenow.com>
Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-05-08 15:18:50 +02:00
Wonsuk Choi
24de260ad2
docs(solid-query): add 'mutationOptions' to config.json navigation (#10455) 2026-04-11 20:15:20 +02:00
Wonsuk Choi
f279ad2488
feat(vue-query): add 'mutationOptions' (#10381)
* feat(vue-query): add 'mutationOptions'

* ci: apply automated fixes

* chore(.changeset): add changeset for 'mutationOptions' in vue-query

* feat(vue-query/mutationOptions): add getter support and fix test descriptions to match actual behavior

* refactor(vue-query): rename 'VueMutationOptions' to 'MutationOptions'

* docs(vue-query): add 'mutationOptions' reference page

* test(vue-query/mutationOptions): add runtime test for getter without 'mutationKey'

* docs(vue-query): add 'mutationOptions' to config.json navigation

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-11 19:49:32 +02:00
thalassophilia
b97513f288
feat(vue-query): add usePrefetchQuery and usePrefetchInfiniteQuery (#10372)
* feat(vue-query): add prefetch composables

- Add usePrefetchQuery and usePrefetchInfiniteQuery to vue-query.
- Includes runtime and type tests, plus a changeset

* docs(vue-query): document prefetch composables

* revert unrelated change

* ci: apply automated fixes

---------

Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-11 15:27:47 +02:00
Zelys
67b12ae1a0
docs: add polling guide (#10330)
* docs(react): add polling guide

Adds a dedicated guide for refetchInterval-based polling. The option was
only mentioned in passing in important-defaults.md with no explanation of
how it works, how to adapt it dynamically, or how it interacts with window
focus, networkMode, and the enabled flag.

Covers:
- Basic setup and independence from staleTime
- Dynamic intervals via function form
- refetchIntervalInBackground for dashboards / always-on UIs
- Disabling window-focus refetching for fullscreen game and kiosk UIs
- Pausing polling with the enabled flag
- networkMode: 'always' for unreliable navigator.onLine environments
- Deduplication behavior across multiple observers

Updates config.json to add the guide to the React sidebar between
Window Focus Refetching and Disabling/Pausing Queries.
Adds a cross-reference in important-defaults.md.

* docs(react/polling): add example markers for framework portability

* docs(react): fix deduplication note — timers are per observer, not per query

* docs(react): address review feedback on polling guide

- Remove staleTime enumeration; link to Important Defaults instead
- Remove game/kiosk focus management examples (scope creep)
- Rewrite pausing polling to use refetchInterval function instead of enabled: false
- Fix offline support section: connectivity uses online/offline events, not navigator.onLine
- Fix deduplication note: remove queuing implication and em dash
- Add non-browser environments note pointing to React Native guide

* docs(solid,vue): add polling guide framework ports

* docs: wrap React Native section in markers for framework port exclusion

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-01 11:04:45 +02:00