Getting Started

Installation

Install the adapter for your framework with your preferred package manager:

npm i @tanstack/react-hotkeys

npm i @tanstack/react-hotkeys

Each 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:

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

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

See the devtools documentation for setup details.