Introduction
react-keyboard is wrap of mousetrap.js in React, it offers keyboard shortcuts handling in React application.

Getting started
Install
Usage Example
Defined keyMap
A KeyMap is an object which value is the key sequence. The key sequence can be:
string
which can be a single keyleft
or combination of keyscommand+k
array
which is an array of multiple key commands:['del', 'backspace']
object
only use an object if you need to listen to specific event type:{combo: 'command+k', eventType: 'keyup'}
Use HotKeys Component
Note: Child HotKeys components can inherit keyMap
from their parents. You don't necessarily define keyMap
for each child if parents already have the shortcuts you need.
Last updated
Was this helpful?