Hotkeys Docs
Getting Started
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/installation.md
Getting Started
Installation
Install the adapter for your framework with your preferred package manager:
shell
npm i @tanstack/react-hotkeysshell
pnpm add @tanstack/react-hotkeysshell
yarn add @tanstack/react-hotkeysshell
bun add @tanstack/react-hotkeysEach framework package re-exports everything from the core @tanstack/hotkeys package, so you don't 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:
shell
npm i @tanstack/react-devtools
npm i @tanstack/react-hotkeys-devtoolsshell
pnpm add @tanstack/react-devtools
pnpm add @tanstack/react-hotkeys-devtoolsshell
yarn add @tanstack/react-devtools
yarn add @tanstack/react-hotkeys-devtoolsshell
bun add @tanstack/react-devtools
bun add @tanstack/react-hotkeys-devtoolsSee the devtools documentation for setup details.