Skip to content

Commit f654e9a

Browse files
committed
docs: devtools documentation for tanstack rebrand
1 parent 822c98c commit f654e9a

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

docs/devtools.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,20 @@ When you begin your React Query journey, you'll want these devtools by your side
99

1010
> Please note that for now, the devtools **do not support React Native**. If you would like to help us make the devtools platform agnostic, please let us know!
1111
12-
## Import the Devtools
12+
## Install and Import the Devtools
1313

14-
The devtools are bundle split into the `react-query/devtools` package. No need to install anything extra, just:
14+
The devtools are a separate package that you need to install:
15+
16+
```bash
17+
$ npm i @tanstack/react-query-devtools
18+
# or
19+
$ yarn add @tanstack/react-query-devtools
20+
```
21+
22+
You can import the devtools like this:
1523

1624
```js
17-
import { ReactQueryDevtools } from 'react-query/devtools'
25+
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
1826
```
1927

2028
By default, React Query Devtools are only included in bundles when `process.env.NODE_ENV === 'development'`, so you don't need to worry about excluding them during a production build.
@@ -26,7 +34,7 @@ Floating Mode will mount the devtools as a fixed, floating element in your app a
2634
Place the following code as high in your React app as you can. The closer it is to the root of the page, the better it will work!
2735

2836
```js
29-
import { ReactQueryDevtools } from 'react-query/devtools'
37+
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
3038

3139
function App() {
3240
return (
@@ -59,7 +67,7 @@ function App() {
5967
Embedded Mode will embed the devtools as a regular component in your application. You can style it however you'd like after that!
6068

6169
```js
62-
import { ReactQueryDevtoolsPanel } from 'react-query/devtools'
70+
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
6371

6472
function App() {
6573
return (

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ You can install React Query with [NPM](https://npmjs.com),
1010
### NPM
1111

1212
```bash
13-
$ npm i react-query
13+
$ npm i @tanstack/react-query
1414
# or
15-
$ yarn add react-query
15+
$ yarn add @tanstack/react-query
1616
```
1717

1818
React Query is compatible with React v16.8+ and works with ReactDOM and React Native.

0 commit comments

Comments
 (0)