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

8 commits

Author SHA1 Message Date
Ciarán Curley
40321a0b1b
docs: add docs for simplified query methods (#10662)
docs: add docs for simplfied impertive query methods

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-22 21:04:36 +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
Wonsuk Choi
e31bda9136
docs(solid-query): convert guide docs to ref-based with Solid-style code (#10146)
* docs(react-query/guides): add markers for solid-query guide overrides

* docs(solid-query/guides): convert guide docs to ref-based with Solid-style code

* docs(config): add solid offline example entry and update lockfile

* ci: apply automated fixes

* docs(react/guides/caching): unify staleTime wording to passive voice

* chore(pnpm-lock.yaml): fix broken lockfile for 'msw' dependency

* docs(solid/guides/caching): remove redundant 'StaleNote' override now unified with react

* docs(react/guides/caching): remove unused 'StaleNote' markers

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-26 14:27:51 +01:00
Lachlan Collins
5ad78fc4ad
docs: correct local relative links (#9947)
* docs: correct local relative links

* Update links

* Slight tweaks

* String
2025-12-05 22:39:25 +11:00
mkmlab-v2
f5363e29de
docs: Add useSuspenseQuery replacement rule for Solid docs (#9815)
Fixes #9654

Solid Query documentation incorrectly shows useSuspenseQuery which doesn't exist in Solid Query. Added replacement rules to convert useSuspenseQuery to useQuery and useSuspenseQueries to useQueries.

This aligns the documentation with the actual Solid Query API.

Co-authored-by: MKM Lab <mkmlab@example.com>
2025-11-01 19:31:13 +01:00
Varun
878782ba04
docs(solid-query): fix incorrect Vue.js code example in Suspense guide (#9813)
* docs(solid-query): fix incorrect Vue.js code example in Suspense guide

Replace Vue.js code example with proper SolidJS syntax in the Suspense documentation.
The example was using Vue's defineComponent and setup() instead of SolidJS patterns.

Fixes issue with non-existent useSuspenseQuery examples in Solid Query docs.

* fix: use idiomatic SolidJS pattern for Suspense

Remove unnecessary createEffect and rely on direct query.data access.
According to TanStack Query Solid docs, accessing query.data directly
inside a Suspense boundary automatically triggers suspension.

Addresses CodeRabbit AI feedback for proper SolidJS patterns.
2025-11-01 19:30:37 +01:00
Anders Madsen
af1de4ddb7
docs: Change the word 'Vue' to 'Solid' (#9287) 2025-06-19 10:26:51 +02:00
Birk Skyum
d040eaacf6
fix(solid-query): deprecate create in favor of use, and add full docs (#8950)
* Revert "fix(solid-query): keep solid-query on just `createQuery` syntax (#8947)"

This reverts commit 4e45d7c9a1.

* Revert "fix(solid-query): use QueryClient from query-core (#8943)"

This reverts commit 8f84606235.

* deprecate create types

* add proper deprecation

* add solid reference

* add solid guides

* request waterfall and advanced ssr

* client-state

* ci: apply automated fixes

* ci: apply automated fixes (attempt 2/3)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-04-03 23:54:40 +02:00