devtools/docs/framework/react/basic-setup.md
Alem Tuzlak 0803d09382
docs: install the framework adapters as dev dependencies everywhere (#547)
The installation page and most of the quick start used `npm install -D`,
but the adapter pages, the basic setup pages, and the Svelte and Angular
quick start used a regular install. Every adapter install now uses -D, and
the installation page says when to use a regular dependency instead.

Fixes #227
2026-10-29 16:17:48 +01:00

2.2 KiB

title id
Basic setup basic-setup

TanStack devtools provides you with an easy to use and modular client that allows you to compose multiple devtools into one easy to use panel.

Setup

Install the TanStack Devtools library, this will install the devtools core as well as provide you framework specific adapters.

npm i -D @tanstack/react-devtools

Next in the root of your application import the TanStackDevtools from the required framework adapter (in this case @tanstack/react-devtools).

import { TanStackDevtools } from '@tanstack/react-devtools'

import App from './App'

createRoot(document.getElementById('root')!).render(
  <StrictMode>
    <App />

    <TanStackDevtools />
  </StrictMode>,
)

Import the desired devtools and provide it to the TanStackDevtools component along with a label for the menu.

Currently TanStack offers:

  • QueryDevtools
  • RouterDevtools
  • PacerDevtools
  • FormDevtools coming soon
import { createRoot } from 'react-dom/client'

import { TanStackDevtools } from '@tanstack/react-devtools'

import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
import { ReactFormDevtoolsPanel } from '@tanstack/react-form-devtools'


import App from './App'

createRoot(document.getElementById('root')!).render(
  <StrictMode>
    <App />

    <TanStackDevtools
      plugins={[
        {
          name: 'TanStack Query',
          render: <ReactQueryDevtoolsPanel />,
        },
        {
          name: 'TanStack Router',
          render: <TanStackRouterDevtoolsPanel />,
        },
        {
          name: 'TanStack Form',
          render: <ReactFormDevtoolsPanel />,
        },
      ]}
    />
  </StrictMode>,
)

Finally add any additional configuration you desire to the TanStackDevtools component, more information can be found under the TanStack Devtools Configuration section.

A complete working example can be found in our basic example.