0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
Commit graph

51 commits

Author SHA1 Message Date
Wonsuk Choi
73c5686de7
docs(examples/{react,solid,vue}): add offline examples for TanStack Router, React Router and Solid Router, and replace the discontinued '@tanstack/react-location' (#12483)
* docs(examples/react/offline): replace the discontinued '@tanstack/react-location' with '@tanstack/react-router' and rename it to 'offline-tanstack-router'

* docs(framework/{vue,preact,angular}/guides/mutations): point the offline example link to each adapter's own example

* docs(examples/{solid,vue}/offline-tanstack-router): use TanStack Router for the offline example, replacing the router-less Solid one and adding one for Vue

* docs(examples/react/offline-react-router): add offline example with React Router

* docs(examples/solid/offline-solid-router): add offline example with Solid Router
2026-11-02 01:49:54 +09:00
Wonsuk Choi
650c69abcd
docs(framework): write snippet durations in 'count * unit * 1000' order (#12381) 2026-10-26 02:26:34 +09:00
Wonsuk Choi
a29c34fd48
docs(framework/angular): use the defined 'QueriesService' in 'queryOptions' and 'mutationOptions' snippets (#12376) 2026-10-26 02:07:05 +09:00
Wonsuk Choi
35c505a5f2
docs(angular/guides/testing): limit the 'whenStable' guidance to work that settles right away and point to fake timers for the rest (#12203) 2026-10-20 15:47:24 +09:00
Wonsuk Choi
b5fe9512df
docs(angular): use 'angular-ts' for the code blocks with '@Component' to highlight their templates (#12202) 2026-10-20 15:30:50 +09:00
Wonsuk Choi
a8f39eea4c
docs(angular/guides/testing): advance fake timers in the mutation example instead of awaiting 'whenStable' (#12201) 2026-10-20 15:26:14 +09:00
Wonsuk Choi
fb53a81e1c
docs(angular/guides/testing): advance fake timers instead of awaiting 'whenStable' in the component examples, and add Angular Testing Library and 'TestBed.runInInjectionContext' variants (#12199)
* docs(angular/guides/testing): advance fake timers and run 'detectChanges' in the component examples with 'TestBed' and Angular Testing Library instead of awaiting 'whenStable'

* docs(angular/guides/testing): add the 'TestBed.runInInjectionContext' variant to the component examples
2026-10-20 15:17:59 +09:00
Wonsuk Choi
608fca7426
docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable' (#12197)
* docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable'

* docs(angular/guides/testing): restore real timers in 'afterEach' in the infinite query example
2026-10-20 14:50:24 +09:00
Wonsuk Choi
86a9c88b38
docs(angular/guides/mutation-options): fix the duplicated 'query-options' id and inject the 'QueryClient' used in the example (#12182) 2026-10-20 12:04:14 +09:00
Wonsuk Choi
c223661efb
docs(angular/guides/testing): use 'provideHttpClientTesting' instead of the deprecated 'HttpClientTestingModule' and add 'initialPageParam' to the infinite query example (#12181) 2026-10-20 12:01:12 +09:00
Wonsuk Choi
4a18a7016e
docs(angular/guides/infinite-queries): add the required 'initialPageParam' to the bi-directional example (#12180) 2026-10-20 12:00:44 +09:00
Wonsuk Choi
ef39130852
docs(angular/guides/query-cancellation): pass filters to 'cancelQueries' and fix the imports of the 'HttpClient' example (#12179) 2026-10-20 12:00:25 +09:00
Wonsuk Choi
87cd8cf855
docs(angular-query-experimental): use descriptive names for remaining generic class fields in guide examples (#11446) 2026-09-08 12:11:39 +09:00
Wonsuk Choi
390de5a8dd
docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples (#11445)
* docs(angular-query-experimental): add 'readonly' and use descriptive names for class fields in guide examples

* docs(angular-query-experimental): use descriptive names for class fields in 'placeholder-query-data.md'
2026-09-08 11:39:41 +09:00
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
Melih Arık
31c7f374e2
docs(angular-query): fix invalid imports and syntax error in guide examples (#11090)
* docs(angular-query): fix three broken examples in the guides

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-02 17:34:23 +09:00
Pavan Shinde
bee96b7ca7
docs(angular): fix QueryClient field in paginated guide (#10147) 2026-02-26 15:04:59 +01:00
Wonsuk Choi
fef7988924
docs(angular/guides/caching): fix typo 'date' to 'data' (#10189) 2026-02-26 14:54:30 +01:00
Pavan Shinde
c2325ed0fe
docs(angular): fix TypeScript anchor link in mutation options (#10121) 2026-02-12 14:00:53 +01:00
Pavan Shinde
ec60e1c954
docs: angular caching queryfn fix (#10092)
* docs: fix grammar in SSR serialization section

* docs(angular): fix queryFn typo in caching guide

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2026-02-11 09:32:41 +01:00
vedanta
8f0d834382
feat: Preact Adapter (#9935)
* initial setup -- duplicated + package.json edited

* simple preact updations

* missed a React.ReactNode

* testing grunt work (preact library + other small issues + ErrorBoundary custom implementation)

* missed a few

* Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality

* useSuspenseQueries left -- removed the useQuery.promise tests

* forgot the console logs

* useSuspenseQueries 2 resolved; tests done

* ci: apply automated fixes

* fix: example

* fix: configs should be symlinks

* fix: sync versions for npm-run-all2

* ref: re-sync runall2

* ref: go back to 5.0.0

* ref: remove changelog

* react-query -> preact-query

* remove use client directive + added the useSyncExternalStore (decoupled from compat)

* remove the react remnants

* generate docs

* typescript eslint

* docs

* vite config fix

* docs now reference react docs (most of them atleast)

* code-rabbit issues addressed

* <div/> lol

* fix: docs

* ci: apply automated fixes

* fix: lockfile

* fix: duplicated versions

* lockfile (I cooked or am I cooked)

* ci: apply automated fixes

* Making small edits to fix versioning, warnings, and lock

* unhandled error compat

* Fixing CI

* Fixed the CI errors

* ci: apply automated fixes

* Prettier format

* Update changeset for Preact Adapter feature

---------

Co-authored-by: TkDodo <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 12:02:20 +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
Lachlan Collins
7f4939c624
ci: sync config between projects (#9931)
* ci: update typedoc

* Remove old check
2025-11-29 19:55:40 +11:00
autofix-ci[bot]
9ede44d25e
ci: apply automated fixes 2025-11-01 18:15:40 +00:00
Varun
571cf55cf1
docs: fix angular background fetching indicators replace rules (#9819)
docs(angular): add missing replace rules for background-fetching-indicators

- Add replace rules to convert React terminology to Angular equivalents
- Fixes useIsFetching -> injectIsFetching conversion in prose text
- Adds hook -> function terminology conversion
- Includes package name conversion for @tanstack/react-query
- Resolves Issue #9744
2025-11-01 19:14:44 +01:00
Arnoud
06e555072b
docs(angular-query): add testing guide (#9669) 2025-09-21 02:38:17 +02:00
Josh
a2151d28e1
feat(query-core): add context to mutationfn & mutation callbacks (#9615)
* feat(query-core): add context to mutationfn

Co-Authored-By: travikk <627275+travikk@users.noreply.github.com>

* fix(query-core): mutation onSuccess scope param should also be undefined

Co-Authored-By: travikk <627275+travikk@users.noreply.github.com>

* feat: add scope deprecate context on mutation state

* feat(query-core): add mutation context to all mutation callbacks

* chore: pr amends

Co-Authored-By: Dominik Dorfmeister <1021430+TkDodo@users.noreply.github.com>

* test(unit): update to handle context in mutation callbacks

* chore: rename to onMutateResult

* chore: revert context deprecation on MutationState

---------

Co-authored-by: travikk <627275+travikk@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <1021430+TkDodo@users.noreply.github.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2025-09-16 10:22:43 +02:00
Arnoud
e75a5f9d55
feat(angular-query): move devtools to conditional sub-paths (#9270)
* feat(angular-query-devtools): move devtools to conditional sub-paths, improves tree shaking and dependency injection

* Fix compatibility with moduleResolution node

* ci: apply automated fixes

* fix preview release for angular-query

* Fix angular-query preview release

* Revert some changes made obsolete by better Vite based alternative

* Update export paths

* Fix production exports and publishconfig

* knip config

* remove postpack

* Generate API reference docs

* type declarations in correct directory

* Update documentation

* knip config

* Optional core devtools dependency

* ci: apply automated fixes

* regenerate api reference docs

* ci: apply automated fixes

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

* regenerate api reference docs

* formatting

* apply coderabbit suggestions

* Improve unit tests

* docs

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-16 00:07:53 +02:00
Arnoud
e3b40d4d0d
chore(angular-query): remove standalone component markers as it's now the default (#9647) 2025-09-12 15:09:42 +02:00
Arnoud
2492ed1d9b
docs(angular-query): fix error in code snippet (#9645) 2025-09-12 01:31:48 +02:00
Pascal Weyrich
7f0e7161e4
docs(angular-query): use signal input in placeholder-query-data.md (#9641) 2025-09-12 00:16:24 +02:00
Tanner Linsley
afc6302dbf docs: fix links
commit 113eb6ba963534fe80b3e96193d767bf769c8bff
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date:   Fri May 23 23:16:11 2025 -0600

    docs: fix: only transform generated reference

commit d1d084ed9026e31ba746e1bb87d5c19183a7d148
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date:   Fri May 23 23:12:07 2025 -0600

    docs: fix broken links

commit 0df59ea7d8afb16be86ae917fc46900b6e999351
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date:   Fri May 23 15:54:19 2025 -0600

    fix: rewrite type doc links to be directory-relative

commit 81e4c71f1c9250005f164b7e585837ee0ad14e23
Author: Tanner Linsley <tannerlinsley@gmail.com>
Date:   Fri May 23 15:14:51 2025 -0600

    fix: initial fix for ./ => ../
2025-05-24 00:47:55 -06:00
Arnoud
572e2a5b44
docs(angular-query): fix links (#9010) 2025-04-13 20:21:31 +02:00
Arnoud
18e357c297
docs(angular-query): document angular httpclient and other data fetching solutions (#8732) 2025-03-01 22:43:55 +01:00
Arnoud
7ff544e12e
docs(angular-query): improve queryOptions code snippets (#8601) 2025-02-02 19:26:57 +01:00
Ayush Seth
6184a89354
docs(angular-query): remove outdated comment from example
* Update invalidations-from-mutations.md

* Update invalidations-from-mutations.md

* restore first code snippet

---------

Co-authored-by: Arnoud de Vries <6420061+arnoud-dv@users.noreply.github.com>
2025-01-03 16:54:42 +01:00
Arnoud
5731a3a267
feat(angular-query): add mutationOptions (#8316) 2024-11-20 13:58:00 +01:00
Arnoud
6a9edbfb44
docs(angular-query): update queryOptions documentation (#8311)
* docs(angular-query): update queryOptions documentation

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-11-19 23:57:22 +01:00
Arnoud
4aff8469aa
fix(angular-query): remove queryClient parameter from callback functions (#8307) 2024-11-19 19:32:49 +01:00
Arnoud
923736c62e
fix(angular-query): support inject(QueryClient) (#8292)
* fix(angular-query): support inject(QueryClient)

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-11-14 22:48:46 +01:00
Arnoud
2459701116
feat(angular-query): add withDevtools and injectDevtoolsPanel 2024-11-07 16:18:52 +01:00
Minko Gechev
27861961bb
docs: update the syntax highlighting for angular (#7762) 2024-07-19 11:36:35 +02:00
Shahar Har-Shuv
d03224770d
docs(angular-query): update disabling-queries.md (#7332) 2024-05-04 20:37:15 +02:00
fuko
8fa82653dd
docs: fix broken internal links in the query docs (#7247)
* wip - 1

* Fix more links

* Fix one more link

* Another one

* Update a link

* Fix the broken links in the Angular docs

* Fix the broken links in the Vue docs

* Fix the Svelte links in the docs

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2024-04-22 10:38:13 +02:00
Tanner Linsley
754640a3e5
docs: migrate docs to use path-based navigation instead of route-based (#7211)
TanStack Router uses path-based navigation instead of route-based navigation, so many of the relative documentation links will be invalid after migration. This fixes that.
2024-04-02 16:46:31 -06:00
Jaaneek
77d5b2eaec
feat: add typesafe query disabling via skipToken (#6999)
* feat: add typesafe react-query disabling via skipToken

* feat: add unique identifier to skip token

* feat(query-core): implement skipToken

* chore(query-core): refactor logic of skipToken

* feat(react-query): do not allow skipToken in useSuspenseQuery

* feat(react-query): handle skip token in suspense react queries, add tests

* refactor(query-core): remove check for queryFn === skipToken, enabled is set to false instead

* refactor(query-core): remove check for queryFn === skipToken, enabled is set to false instead

* chore(react-query): remove unused imports

* fix(react-query): update test to display error message in error boundary

* fix(query-core): reduce bundle size by using Symbol() instead of Symbol.for

* fix(query-core): move check for skipToken into already existing if statement

* refactor(query-core): remove no longer needed check for skipToken

* refactor(query-core): make sure enabled===true takes precendence over skipToken

* refactor(react-query): remove unnecesary check for skipToken

* feat: bring back logging in dev mode

* docs: use `skipToken` in TypeScript examples

* refactor: remove checks that shouldn't be necessary because we now assign `enabled` in `defaultQueryOptions`

* types: adjust useQueries types in non-react adapters

* fix: infiniteQueryBehavior needs to _create_ a function that rejects if we have a skipToken, not reject right away

* refactor: flip condition

* try to fix query options

* fix: make core compilable

* fix: allow skipToken on type level for useSuspenseQuery and warn at runtime

it won't work anyways

* test: dataTag + skipToken

* chore: remove a test that doesn't make much sense

* chore: solid tests

* chore: stabilize test

* rewrite test

* test(react-query): remove not needed doNotExecute from test, test-d.tsx files are not executed anyway

* docs(react-query): add example of skipToken into react-query disabling-queries docs

* docs: update disabling queries examples in Angular, React, and Vue guides

* docs: add description of skipToken to typescript.md

* test(react-query): add unique queryKey to should respect skipToken test

* test(react-query): use helper function instead of string in should respect skipToken test

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2024-03-05 15:55:01 +01:00
Arnoud
ef1f7c1e37
feat(angular-query): injectMutationState (#6925)
* feat(angular-query): inject mutation state

* add type tests
2024-02-18 14:43:53 +01:00
Arnoud
c2dc9bb05a
feat(angular-query): injectInfiniteQuery (#6808) 2024-02-04 22:42:16 +01:00
Lachlan Collins
5a5b61b19b
docs: Fix relative link depth (#6778) 2024-01-26 19:53:40 +11:00
Lachlan Collins
9739c8d12c
docs: Fix path in refs field (#6774) 2024-01-26 14:31:25 +11:00