devtools/packages/react-devtools
github-actions[bot] 71b2ad0bb6
ci: Version Packages (#506)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
History 2026-08-19 18:56:50 +02:00
..
src feat: extract theme provider (#386) 2026-03-15 09:38:49 +01:00
tests chore: upgrade Vitest to v4 (#497) 2026-08-12 16:20:22 +02:00
CHANGELOG.md ci: Version Packages (#506) 2026-08-19 18:56:50 +02:00
eslint.config.js init 2025-07-25 16:40:55 -05:00
package.json ci: Version Packages (#506) 2026-08-19 18:56:50 +02:00
README.md docs: add README header banners to the framework adapter packages (#491) 2026-08-03 11:59:03 +02:00
tsconfig.docs.json init 2025-07-25 16:40:55 -05:00
tsconfig.json init 2025-07-25 16:40:55 -05:00
vite.config.ts docs: correct local relative links (#282) 2025-12-05 22:38:56 +11:00

TanStack React Devtools
# @tanstack/react-devtools

This package is still under active development and might have breaking changes in the future. Please use it with caution.

Usage

import { TanStackDevtools } from '@tanstack/react-devtools'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
const queryClient = new QueryClient()
function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <h1>My App</h1>
      <TanStackDevtools
        plugins={[
          {
            name: 'TanStack Query',
            render: <ReactQueryDevtoolsPanel />,
          },
          {
            name: 'TanStack Router',
            render: <TanStackRouterDevtoolsPanel router={router} />,
          },
        ]}
      />
    </QueryClientProvider>
  )
}

Creating plugins

In order to create a plugin for TanStack Devtools, you can use the plugins prop of the TanStackDevtools component. Here's an example of how to create a simple plugin:

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

function App() {
  return (
    <div>
      <h1>My App</h1>
      <TanStackDevtools
        plugins={[
          {
            id: 'your-plugin-id',
            name: 'Your Plugin',
            render: <CustomPluginComponent />,
          },
        ]}
      />
    </div>
  )
}