Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Getting Started

Installation

TanStack Hotkeys is compatible with various front-end frameworks. Install the corresponding adapter for your framework using your preferred package manager:

sh
npm i @tanstack/react-hotkeys

Each framework package re-exports everything from the core @tanstack/hotkeys package, so there is no need to install the core package separately.

Note

If you are not using a framework, you can install the core @tanstack/hotkeys package directly for use with vanilla JavaScript.

Start with the Quick Start guide. If you want the integrated devtools panel, also install:

sh
npm i @tanstack/react-devtools
npm i @tanstack/react-hotkeys-devtools

See the devtools documentation for setup details.