@f/keychord

Takes in a keypress/keydown/keyup event and returns a chord striE.g. 'ctrl+shift+t'

Stats

StarsIssuesVersionUpdatedCreatedSize
@f/keychord
201.1.16 years ago6 years agoMinified + gzip package size for @f/keychord in KB

Readme

keychord

Build status Git tag NPM version Code style

Takes in a keypress/keydown/keyup event and returns a chord striE.g. 'ctrl+shift+t'

Installation

$ npm install @f/keychord

Usage

var keychord = require('@f/keychord')

function render () {
  return <div onKeypress={handleKeypress} />
}

function handleKeypress (e) {
  switch (keychord(e)) {
    case 'enter':
      // handle enter
      break
    case 'shift+enter':
      // handle shift+enter
      break
    case 'ctrl+up':
      // handle ctrl+up
      break
  }
}

API

keychord(event)

Returns: A keychord string. If only one key is being pressed, just returns the name of that key. If it is a sequence of keys, returns a string of the form 'ctrl+shift+enter'.

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.