📄 tanstack/devtools/latest/docs/plugin-configuration

File: plugin-configuration.md | Updated: 11/15/2025

Source: https://tanstack.com/devtools/latest/docs/plugin-configuration



TanStack

Devtools v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React logo

React

Version

Latest

Search...

+ K

Menu

Getting Started

Guides

API Reference

Examples

Framework

React logo

React

Version

Latest

Menu

Getting Started

Guides

API Reference

Examples

On this page

Plugin Configuration

Copy Markdown

Plugin Configuration
====================

You can configure TanStack Devtools plugins by passing them as an array to the plugins prop of the TanStackDevtools component.

Each plugin can have the following configuration options:

  • render (required) - A React component that renders the plugin's UI
  • defaultOpen (optional) - A boolean that determines if the plugin panel is open by default (default: false).
  • id (optional) - A unique identifier for the plugin. If not provided, a random id will be generated.

Here's an example of how to configure plugins in the TanStackDevtools component:

tsx

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

function App() {
  return (
    <>
      <YourApp />
      <TanStackDevtools
        plugins={[\
          { \
            name: 'TanStack Form',\
            render: <FormDevtools />,\
            defaultOpen: true,\
          },\
        ]}
      />
    </>
  )
}


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

function App() {
  return (
    <>
      <YourApp />
      <TanStackDevtools
        plugins={[\
          { \
            name: 'TanStack Form',\
            render: <FormDevtools />,\
            defaultOpen: true,\
          },\
        ]}
      />
    </>
  )
}

Default open
------------

You can set a plugin to be open by default by setting the defaultOpen property to true when configuring the plugin. This will make the plugin panel open when the devtools are first loaded.

If you only have 1 plugin it will automatically be opened regardless of the defaultOpen setting.

The limit to open plugins is at 3 panels at a time. If more than 3 plugins are set to defaultOpen: true, only the first 3 will be opened.

This does not override the settings saved in localStorage. If you have previously opened the plugin panel, and selected some plugins to be open or closed, those settings will take precedence over the defaultOpen setting.

Edit on GitHub

Configuration

Installation

Partners Become a Partner

Code RabbitCode Rabbit CloudflareCloudflare AG GridAG Grid NetlifyNetlify NeonNeon WorkOSWorkOS ClerkClerk ConvexConvex ElectricElectric SentrySentry PrismaPrisma StrapiStrapi UnkeyUnkey