0.0.3 • Published 7 years ago

react-bind-shortcut v0.0.3

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

react-bind-shortcut

The component that receives the values of the pressed keyboard keys

How use

import KeyBinding from 'react-bind-shortcut';

  ...

const ReactComponent = React.createClass({

  ...

  holdKeyChanged(holdKey) {
    // hold key name
  },
  pressKeyChanged(keysPressed) {
    // pressed keys or shortcuts names
  },

  ...

});

const boundKeys = [
'Enter',
'ESC',
'shIFt'
];

const boundShortcuts = [
'SHIFT + A',
'alt+b',
'Ctrl + C'
];

const holdTimer = 500;

export default KeyBinding(ReactComponent, boundKeys, boundShortcuts, holdTimer);

// or without holdTimer:
//default holdTimer = 1000
export default KeyBinding(ReactComponent, boundKeys, boundShortcuts);

// if not pass boundKeys and boundShortcuts, then the method pressKeyChanged()
// will be called when any keys are pressed
export default KeyBinding(ReactComponent);