Devtools

TanStack Hotkeys ships devtools for debugging and monitoring your registered hotkeys in real time, as a panel inside the TanStack Devtools multi-panel UI.

Features#

The Hotkeys devtools panel lets you:

• View all currently registered hotkeys with their options and status
• See which keys are held down in real time
• Trigger hotkey callbacks for testing, without pressing the keys
• Inspect individual registrations, including their target, event type, and conflict behavior

Installation#

Install the devtools packages for your framework:

React#

npm install @tanstack/react-devtools @tanstack/react-hotkeys-devtools

Preact#

npm install @tanstack/preact-devtools @tanstack/preact-hotkeys-devtools

Solid#

npm install @tanstack/solid-devtools @tanstack/solid-hotkeys-devtools

Vue#

npm install @tanstack/vue-hotkeys-devtools

Angular and Lit do not currently ship a dedicated hotkeys devtools adapter.

Setup#

React setup#

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

function App() {
  return <TanStackDevtools plugins={[hotkeysDevtoolsPlugin()]} />
}

Preact setup#

import { TanStackDevtools } from '@tanstack/preact-devtools'
import { hotkeysDevtoolsPlugin } from '@tanstack/preact-hotkeys-devtools'

export function App() {
  return <TanStackDevtools plugins={[hotkeysDevtoolsPlugin()]} />
}

Solid setup#

import { TanStackDevtools } from '@tanstack/solid-devtools'
import { hotkeysDevtoolsPlugin } from '@tanstack/solid-hotkeys-devtools'

export function App() {
  return <TanStackDevtools plugins={[hotkeysDevtoolsPlugin()]} />
}

Vue setup#

<script setup lang="ts">
import { HotkeysDevtoolsPanel } from '@tanstack/vue-hotkeys-devtools'
</script>

<template>
  <AppContent />
  <HotkeysDevtoolsPanel />
</template>

For React, Preact, and Solid, the Hotkeys panel appears alongside any other TanStack devtools plugins you have installed.

Standalone panel#

React, Preact, and Solid also export HotkeysDevtoolsPanel for rendering without the TanStack Devtools dock:

import { HotkeysDevtoolsPanel } from '@tanstack/react-hotkeys-devtools'

function DebugPanel() {
  return <HotkeysDevtoolsPanel />
}

Use the corresponding @tanstack/preact-hotkeys-devtools or @tanstack/solid-hotkeys-devtools import for those frameworks. The panel and no-op component also accept an omitted props argument during rendering. Both props are optional: theme defaults to 'dark' and devtoolsOpen defaults to true. Pass theme="light" to select the light theme. When using hotkeysDevtoolsPlugin(), the dock supplies these props and its values take precedence over the standalone defaults.

Production builds#

In production builds, the framework devtools adapters return no-op implementations, so they don't affect your bundle's behavior.

React also exposes a production import for when you explicitly want the plugin in production:

import { hotkeysDevtoolsPlugin } from '@tanstack/react-hotkeys-devtools/production'