Installation | TanStack Hotkeys Docs

TanStack Hotkeys is compatible with various front-end frameworks. Install the corresponding adapter for your framework using 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 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:

Start with the API reference and guides. If you want the integrated devtools panel, also install:

Start with the Quick Start guide and the Angular-specific guides.

Angular currently ships the hotkeys adapter only, so no dedicated Angular devtools package is required.

Start with the Quick Start guide and the Vue-specific guides.

If you want the Vue devtools panel component, also install:

Start with the Quick Start guide and the Lit-specific guides.

Lit currently ships the hotkeys adapter only, so no dedicated Lit devtools package is required.

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.