
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@reecelucas/react-use-hotkeys
Advanced tools
React hook for creating simple keyboard shortcuts.
npm install @reecelucas/react-use-hotkeys
This package has a single dependency, a tiny shim called shim-keyboard-event-key
that normalises the non-standard KeyBoardEvent.key
values implemented in Edge and IE.
All hotkey combinations must use valid KeyBoardEvent
"key"
values. A full list can be found on MDN and Wes Bos has created a great interactive lookup.
// Single keys
useHotkeys('Escape', () => {
console.log('some action');
});
useHotkeys('F7', () => {
console.log('some action');
});
// Modifier combinations
useHotkeys('Meta+Shift+z', () => {
console.log('some action');
});
// Key sequences
useHotkeys('w s d', () => {
console.log('some action');
});
useHotkeys('w " " d', () => {
// space key in sequence (`w ' ' d` also works)
console.log('some action');
});
The following patterns are not supported (yet):
// Modifier keys in sequences
useHotkeys('Control i d', () => {
console.log("I won't run!");
});
// Modifier combinations in sequences
useHotkeys('Control+z i d', () => {
console.log("I won't run!");
});
// Multiple combinations mapped to the same callback
useHotkeys(['Control+z', 'Meta+z'], () => {
console.log("I won't run!");
});
If you find a use case where the API is too restrictive you can use the escape hatch to perform whatever custom logic you need:
useHotkeys('*', event => {
console.log("I will run on every keydown");
if (customKeyLogic(event)) {
console.log("some action");
}
});
useHotkeys(hotkeys: string, callback: (event: KeyboardEvent) => void);
Tests use Jest and react-testing-library.
git clone git@github.com:reecelucas/react-use-hotkeys.git
cd react-use-hotkeys
yarn
yarn test
FAQs
React hook to create keyboard shortcuts
The npm package @reecelucas/react-use-hotkeys receives a total of 5,701 weekly downloads. As such, @reecelucas/react-use-hotkeys popularity was classified as popular.
We found that @reecelucas/react-use-hotkeys demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.