Skip to content

docs: examples to beta #5772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 25, 2023
Merged

docs: examples to beta #5772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5eeb154
docs: mention beta
TkDodo Jul 24, 2023
02d9141
docs: make example use beta.0
TkDodo Jul 24, 2023
4ce99cd
docs: examples to beta
TkDodo Jul 24, 2023
8415aff
Merge branch 'beta' into feature/depend-on-beta
TkDodo Jul 24, 2023
e1aae31
Merge branch 'beta' into feature/depend-on-beta
TkDodo Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Hooks for fetching, caching and updating asynchronous data in React, Solid, Svel
<img src="https://github.com/TanStack/query/workflows/react-query%20tests/badge.svg" />
</a><a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent">
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" />
</a><a href="https://bundlejs.com/?q=%40tanstack%2Freact-query%40alpha&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent">
<img alt="" src="https://deno.bundlejs.com/?q=@tanstack/react-query@alpha&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" />
</a><a href="https://bundlejs.com/?q=%40tanstack%2Freact-query%40beta&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent">
<img alt="" src="https://deno.bundlejs.com/?q=@tanstack/react-query@beta&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" />
</a><a href="#badge">
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
</a><a href="https://github.com/TanStack/query/discussions">
Expand Down
16 changes: 8 additions & 8 deletions docs/react/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ You can install React Query via [NPM](https://npmjs.com/),
or a good ol' `<script>` via
[ESM.sh](https://esm.sh/).

> v5 is currently in alpha.
> v5 is currently in beta. We don't anticipate any major API changes from here on out, but we do expect some minor changes and fixes. We encourage you to try it out and report any issues you find.

### NPM

```bash
$ npm i @tanstack/react-query@alpha
$ npm i @tanstack/react-query@beta
# or
$ pnpm add @tanstack/react-query@alpha
$ pnpm add @tanstack/react-query@beta
# or
$ yarn add @tanstack/react-query@alpha
$ yarn add @tanstack/react-query@beta
```

React Query is compatible with React v18+ and works with ReactDOM and React Native.
Expand All @@ -31,7 +31,7 @@ If you're not using a module bundler or package manager, you can also use this l
<script type="module">
import React from 'https://esm.sh/react@18.2.0'
import ReactDOM from 'https://esm.sh/react-dom@18.2.0'
import { QueryClient } from 'https://esm.sh/@tanstack/react-query@alpha'
import { QueryClient } from 'https://esm.sh/@tanstack/react-query@beta'
</script>
```

Expand All @@ -57,9 +57,9 @@ opera >= 77
It is recommended to also use our [ESLint Plugin Query](./eslint/eslint-plugin-query) to help you catch bugs and inconsistencies while you code. You can install it via:

```bash
$ npm i -D @tanstack/eslint-plugin-query@alpha
$ npm i -D @tanstack/eslint-plugin-query@beta
# or
$ pnpm add -D @tanstack/eslint-plugin-query@alpha
$ pnpm add -D @tanstack/eslint-plugin-query@beta
# or
$ yarn add -D @tanstack/eslint-plugin-query@alpha
$ yarn add -D @tanstack/eslint-plugin-query@beta
```
8 changes: 4 additions & 4 deletions docs/svelte/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ title: Installation

You can install Svelte Query via [NPM](https://npmjs.com).

> v5 is currently in alpha.
> v5 is currently in beta. We don't anticipate any major API changes from here on out, but we do expect some minor changes and fixes. We encourage you to try it out and report any issues you find.

### NPM

```bash
$ npm i @tanstack/svelte-query@alpha
$ npm i @tanstack/svelte-query@beta
# or
$ pnpm add @tanstack/svelte-query@alpha
$ pnpm add @tanstack/svelte-query@beta
# or
$ yarn add @tanstack/svelte-query@alpha
$ yarn add @tanstack/svelte-query@beta
```

> Wanna give it a spin before you download? Try out the [basic](/query/v4/docs/svelte/examples/svelte/basic) example!
8 changes: 4 additions & 4 deletions docs/vue/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ title: Installation

You can install Vue Query via [NPM](https://npmjs.com).

> v5 is currently in alpha.
> v5 is currently in beta. We don't anticipate any major API changes from here on out, but we do expect some minor changes and fixes. We encourage you to try it out and report any issues you find.

### NPM

```bash
$ npm i @tanstack/vue-query@alpha
$ npm i @tanstack/vue-query@beta
# or
$ pnpm add @tanstack/vue-query@alpha
$ pnpm add @tanstack/vue-query@beta
# or
$ yarn add @tanstack/vue-query@alpha
$ yarn add @tanstack/vue-query@beta
```

> Wanna give it a spin before you download? Try out the [basic](../examples/vue/basic) example!
Expand Down
6 changes: 3 additions & 3 deletions examples/react/algolia/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
"dependencies": {
"@algolia/client-search": "4.17.1",
"@algolia/transporter": "4.17.1",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"algoliasearch": "4.17.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@tanstack/eslint-plugin-query": "^5.0.0-alpha.74",
"@tanstack/eslint-plugin-query": "^5.0.0-beta.0",
"@types/react": "^18.2.4",
"@types/react-dom": "^18.2.4",
"@vitejs/plugin-react": "^4.0.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/auto-refetching/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/basic-graphql-request/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"graphql-request": "^6.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81"
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0"
},
"devDependencies": {
"@vitejs/plugin-react": "^4.0.0",
Expand Down
10 changes: 5 additions & 5 deletions examples/react/basic-typescript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/query-sync-storage-persister": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query-persist-client": "^5.0.0-alpha.81",
"@tanstack/query-sync-storage-persister": "^5.0.0-beta.0",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"@tanstack/react-query-persist-client": "^5.0.0-beta.0",
"axios": "^1.4.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@tanstack/eslint-plugin-query": "^5.0.0-alpha.74",
"@tanstack/eslint-plugin-query": "^5.0.0-beta.0",
"@types/react": "^18.2.4",
"@types/react-dom": "^18.2.4",
"@vitejs/plugin-react": "^4.0.0",
Expand Down
6 changes: 3 additions & 3 deletions examples/react/basic/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@tanstack/eslint-plugin-query": "^5.0.0-alpha.74",
"@tanstack/eslint-plugin-query": "^5.0.0-beta.0",
"@vitejs/plugin-react": "^4.0.0",
"vite": "^4.4.4"
},
Expand Down
4 changes: 2 additions & 2 deletions examples/react/default-query-function/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
4 changes: 2 additions & 2 deletions examples/react/infinite-query-with-max-pages/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/load-more-infinite-scroll/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
6 changes: 3 additions & 3 deletions examples/react/nextjs-suspense-streaming/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
"start": "next start"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query-next-experimental": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"@tanstack/react-query-next-experimental": "^5.0.0-beta.0",
"next": "^13.4.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/nextjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"start": "next start"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"ky": "^0.33.3",
"ky-universal": "^0.11.0",
"next": "^13.4.4",
Expand Down
8 changes: 4 additions & 4 deletions examples/react/offline/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/query-sync-storage-persister": "^5.0.0-alpha.81",
"@tanstack/query-sync-storage-persister": "^5.0.0-beta.0",
"@tanstack/react-location": "^3.7.0",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query-persist-client": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"@tanstack/react-query-persist-client": "^5.0.0-beta.0",
"ky": "^0.33.3",
"msw": "^0.39.2",
"react": "^18.2.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/optimistic-updates-typescript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "pages/index.tsx",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/pagination/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/playground/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
4 changes: 2 additions & 2 deletions examples/react/prefetching/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"isomorphic-unfetch": "4.0.2",
"next": "^13.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/react-native/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"@react-native-community/netinfo": "^9.3.7",
"@react-navigation/native": "^6.1.6",
"@react-navigation/stack": "^6.3.16",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"expo": "^48.0.17",
"expo-constants": "^14.2.1",
"expo-status-bar": "^1.4.4",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/react-router/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"localforage": "^1.10.0",
"match-sorter": "^6.3.1",
"react": "^18.2.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/rick-morty/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"@emotion/styled": "^11.11.0",
"@mui/material": "^5.13.2",
"@mui/styles": "^5.13.2",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-router": "^6.11.2",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/simple/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"preview": "vite preview"
},
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
4 changes: 2 additions & 2 deletions examples/react/star-wars/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"@emotion/styled": "^11.11.0",
"@mui/material": "^5.13.2",
"@mui/styles": "^5.13.2",
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-router": "^6.11.2",
Expand Down
4 changes: 2 additions & 2 deletions examples/react/suspense/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"private": true,
"main": "src/index.jsx",
"dependencies": {
"@tanstack/react-query": "^5.0.0-alpha.81",
"@tanstack/react-query-devtools": "^5.0.0-alpha.81",
"@tanstack/react-query": "^5.0.0-beta.0",
"@tanstack/react-query-devtools": "^5.0.0-beta.0",
"axios": "^1.4.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand Down
2 changes: 1 addition & 1 deletion examples/solid/basic-graphql-request/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"license": "MIT",
"dependencies": {
"@tanstack/solid-query": "^5.0.0-alpha.81",
"@tanstack/solid-query": "^5.0.0-beta.0",
"graphql": "^16.6.0",
"graphql-request": "^6.1.0",
"solid-js": "^1.7.8"
Expand Down
2 changes: 1 addition & 1 deletion examples/solid/basic-typescript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"license": "MIT",
"dependencies": {
"@tanstack/solid-query": "^5.0.0-alpha.81",
"@tanstack/solid-query": "^5.0.0-beta.0",
"solid-js": "^1.7.8"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion examples/solid/default-query-function/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"license": "MIT",
"dependencies": {
"@tanstack/solid-query": "^5.0.0-alpha.81",
"@tanstack/solid-query": "^5.0.0-beta.0",
"solid-js": "^1.7.8"
},
"devDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions examples/solid/simple/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
},
"license": "MIT",
"dependencies": {
"@tanstack/solid-query": "^5.0.0-alpha.81",
"@tanstack/solid-query": "^5.0.0-beta.0",
"solid-js": "^1.7.8"
},
"devDependencies": {
"@tanstack/eslint-plugin-query": "^5.0.0-alpha.74",
"@tanstack/eslint-plugin-query": "^5.0.0-beta.0",
"typescript": "^5.0.4",
"vite": "^4.4.4",
"vite-plugin-solid": "^2.7.0"
Expand Down
Loading