1
1
<img referrerpolicy =" no-referrer-when-downgrade " src =" https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133 " />
2
2
3
- ![ TanStack Query Header] ( https://github.com/TanStack/query/raw/main/media/repo-header.png )
4
-
5
- Hooks for fetching, caching and updating asynchronous data in React, Solid, Svelte and Vue
6
-
7
- <a href =" https://twitter.com/intent/tweet?button_hashtag=TanStack " target =" \_parent " >
8
- <img alt =" #TanStack " src =" https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack " >
9
- </a ><a href =" https://discord.com/invite/WrRKjPJ " target =" \_parent " >
10
- <img alt =" " src =" https://img.shields.io/badge/Discord-TanStack-%235865F2 " />
11
- </a ><a href =" https://www.npmjs.com/package/@tanstack/query-core " target =" \_parent " >
12
- <img alt =" " src =" https://img.shields.io/npm/dm/@tanstack/query-core.svg " />
13
- </a ><a href =" https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge= " target =" \_parent " >
14
- <img alt =" " src =" https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed " />
15
- </a ><a href =" #badge " >
16
- <img alt =" semantic-release " src =" https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg " >
17
- </a ><a href =" https://github.com/TanStack/query/discussions " >
18
- <img alt =" Join the discussion on Github " src =" https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue " />
19
- </a ><a href =" https://bestofjs.org/projects/tanstack-query " ><img alt =" Best of JS " src =" https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fquery%26since=daily " /></a ><a href =" https://github.com/TanStack/query/ " target =" \_parent " >
20
- <img alt =" " src =" https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star " />
21
- </a ><a href =" https://twitter.com/tannerlinsley " target =" \_parent " >
22
- <img alt =" " src =" https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow " />
23
- </a > <a href =" https://gitpod.io/from-referrer/ " >
24
- <img src =" https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod " alt =" Gitpod Ready-to-Code " />
3
+ <div align =" center " >
4
+ <img src =" ./media/header_query.png " alt =" TanStack Query " />
5
+ </div >
6
+
7
+ An async state management library built to simplify fetching, caching, synchronizing, and updating server state.
8
+
9
+ - Protocol‑agnostic fetching (REST, GraphQL, promises, etc.)
10
+ - Caching, refetching, pagination & infinite scroll
11
+ - Mutations, dependent queries & background updates
12
+ - Prefetching, cancellation & React Suspense support
13
+
14
+ <a href =" https://tanstack.com/query " style =" font-weight : bold " >Read the Query Docs →</a >
15
+ <br />
16
+
17
+ <div align =" center " style =" display : flex ; gap : 10px ; flex-direction : column ; justify-content : center ;" >
18
+
19
+ <div align =" center " >
20
+ <a href =" https://www.npmjs.com/package/@tanstack/query-core " target =" \_parent " >
21
+ <img alt =" " src =" https://img.shields.io/npm/dm/@tanstack/query-core.svg " alt =" npm downloads " />
25
22
</a >
23
+ <a href =" https://github.com/TanStack/query/ " target =" \_parent " >
24
+ <img alt =" " src =" https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star " alt =" GitHub stars " />
25
+ </a >
26
+ <a href =" https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge= " target =" \_parent " >
27
+ <img alt =" " src =" https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed " alt =" Bundle size " />
28
+ </a >
29
+ </div >
30
+
31
+ <div align =" center " >
32
+ <a href =" #badge " >
33
+ <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
34
+ </a >
35
+ <a href =" https://bestofjs.org/projects/tanstack-query " ><img alt =" Best of JS " src =" https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fquery%26since=daily " /></a >
36
+ <a href =" https://twitter.com/tan_stack " ><img src =" https://img.shields.io/twitter/follow/tan_stack.svg?style=social " alt =" Follow @TanStack " /></a >
37
+ </div >
38
+
39
+ <div align =" center " style =" font-size : 2rem ; font-weight : bolder ;" >
26
40
27
- Enjoy this library? Try the entire [ TanStack ] ( https://tanstack.com ) ! [ TanStack Table ] ( https://github.com/TanStack/table ) , [ TanStack Router ] ( https://github.com/tanstack/router ) , [ TanStack Virtual ] ( https://github.com/tanstack/virtual ) , [ React Charts ] ( https://github.com/TanStack/react-charts ) , [ React Ranger ] ( https://github.com/TanStack/ranger )
41
+ [ Become a Sponsor! ] ( https://github.com/sponsors/tannerlinsley/ )
28
42
29
- ## Visit [ tanstack.com/query ] ( https://tanstack.com/query ) for docs, guides, API and more!
43
+ </ div >
30
44
31
- Still on ** React Query v2** ? No problem! Check out the v2 docs here: https://github.com/TanStack/query/tree/2.x/docs/src/pages/docs .<br />
32
- Still on ** React Query v3** ? No problem! Check out the v3 docs here: https://tanstack.com/query/v3/docs/ .<br />
33
- Still on ** React Query v4** ? No problem! Check out the v4 docs here: https://tanstack.com/query/v4/docs/ .
45
+ </div >
34
46
35
- ## Quick Features
47
+ ## Get Involved
36
48
37
- - Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
38
- - Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
39
- - Parallel + Dependent Queries
40
- - Mutations + Reactive Query Refetching
41
- - Multi-layer Cache + Automatic Garbage Collection
42
- - Paginated + Cursor-based Queries
43
- - Load-More + Infinite Scroll Queries w/ Scroll Recovery
44
- - Request Cancellation
45
- - [ React Suspense] ( https://react.dev/reference/react/Suspense ) + Fetch-As-You-Render Query Prefetching
46
- - Dedicated Devtools
49
+ - We welcome issues and pull requests!
50
+ - Participate in [ GitHub discussions] ( https://github.com/TanStack/query/discussions )
51
+ - Chat with the community on [ Discord] ( https://discord.com/invite/WrRKjPJ )
52
+ - See [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) for setup instructions
47
53
48
54
## Partners
49
55
56
+ <div style =" display : flex ; flex-wrap : wrap ; gap : 50px ; justify-content : center ; align-items : center ;" >
50
57
<a href =" https://www.speakeasy.com/product/react-query?utm_source=tanstack&utm_campaign=tanstack " >
51
58
<picture >
52
59
<source
@@ -64,11 +71,23 @@ Still on **React Query v4**? No problem! Check out the v4 docs here: https://tan
64
71
/>
65
72
</picture >
66
73
</a >
74
+ </div >
67
75
68
- ## Contributing
69
-
70
- View the contributing guidelines [ here] ( /CONTRIBUTING.md )
76
+ ## Explore the TanStack Ecosystem
71
77
72
- ### [ Become a Sponsor!] ( https://github.com/sponsors/tannerlinsley/ )
78
+ <div align =" center " >
79
+ <a href =" https://github.com/tanstack/config " style =" font-weight : bold ;" >TanStack Config</a > – Tooling for JS/TS packages <br />
80
+ <a href =" https://github.com/tanstack/db " style =" font-weight : bold ;" >TanStack DB</a > – Reactive sync client store <br />
81
+ <a href =" https://github.com/tanstack/devtools " style =" font-weight : bold ;" >TanStack DevTools</a > – Unified devtools panel <br />
82
+ <a href =" https://github.com/tanstack/form " style =" font-weight : bold ;" >TanStack Form</a > – Type‑safe form state <br />
83
+ <a href =" https://github.com/tanstack/pacer " style =" font-weight : bold ;" >TanStack Pacer</a > – Debouncing, throttling, batching <br />
84
+ <a href =" https://github.com/tanstack/ranger " style =" font-weight : bold ;" >TanStack Ranger</a > – Range & slider primitives <br />
85
+ <a href =" https://github.com/tanstack/router " style =" font-weight : bold ;" >TanStack Router</a > – Type‑safe routing, caching & URL state<br />
86
+ <a href =" https://github.com/tanstack/router " style =" font-weight : bold ;" >TanStack Start</a > – Full‑stack SSR & streaming<br />
87
+ <a href =" https://github.com/tanstack/store " style =" font-weight : bold ;" >TanStack Store</a > – Reactive data store <br />
88
+ <a href =" https://github.com/tanstack/table " style =" font-weight : bold ;" >TanStack Table</a > – Headless datagrids <br />
89
+ <a href =" https://github.com/tanstack/virtual " style =" font-weight : bold ;" >TanStack Virtual</a > – Virtualized rendering <br />
90
+ … and more at <a href =" https://tanstack.com " style =" font-weight : bold ;" >TanStack.com »</a >
91
+ </div >
73
92
74
93
<!-- Use the force, Luke -->
0 commit comments