useKeyboardShortcut
A custom React hook that allows adding keyboard shortcuts to a React application.
import React from 'react'
import useKeyboardShortcut from 'use-keyboard-shortcut'
const App = () => {
useKeyboardShortcut(['Shift', 'H'], () => console.log('Shift + H has been pressed.'))
return (
<div>Hello World</div>
)
}
For another example on how to use this hook, please see the example project
Documentation
useKeyboardShortcut(keysArray, callback)
keysArray
should be an array of KeyboardEvent.key
strings. A full list of strings can be seen here
callback
should be a function that is called once the keys have been pressed.