keypress-combination v0.9.2

Keypress combination

Attach listeners to keypress combinations like CTRL-1. Lightweight and well documented.

// Keycode for CTRL is 17, keycode for 1 is 49
emitter.addListener(17, 49, function() {
  console.log("Pressed CTRL-1");
});

See the demo at jsfiddle.net/pushtell/164prhaz.

Please ★ on GitHub!

• Installation
• Usage
• API Reference
  • KeypressCombinationEmitter
    • constructor
    • .addListener(keyCode, [keyCode, ...] callback)
  • Subscription
    • .remove()
• Keycodes
• Tests
  • Browser Coverage
  • Running Tests

Installation

npm install keypress-combination

Usage

Try it on JSFiddle

var KeypressCombinationEmitter = require("keypress-combination");

var emitter = new KeypressCombinationEmitter();

// CTRL Keycode: 17
// 1 Keycode: 49
var subscription = emitter.addListener(17, 49, function() {
  console.log("Pressed CTRL-1");
});

// Remove the callback when no longer needed.
subscription.remove();

API Reference

KeypressCombinationEmitter

Emitter responsible for coordinating combination keypress events.

constructor

Create a new emitter.

• Return Type:
• Parameters:
  • No parameters.

.addListener(keyCode, [keyCode, ...] callback)

Add an event listener

• Return Type:
• Parameters:
  • keyCode - Character keycode. See the keycodes section for more information.
    • Required
    • Type: number
    • Example: 49
  • callback - Callback function.
    • Required
    • Type: function
    • Example: function() { console.log("Press") }

Subscription

.remove()

• Return Type: No return value
• Parameters:
  • No parameters.

Keycodes

Note that keycodes are not fully standardized across browsers.

Tests

Browser Coverage

Karma tests are performed on Browserstack in the following browsers:

• IE 9, Windows 7
• IE 10, Windows 7
• IE 11, Windows 7
• Opera (latest version), Windows 7
• Firefox (latest version), Windows 7
• Chrome (latest version), Windows 7
• Safari (latest version), OSX Yosemite
• Mobile Safari (latest version), iPhone 6, iOS 8.3

Please let us know if a different configuration should be included here.

Running Tests

Locally:

npm test

On Browserstack:

BROWSERSTACK_USERNAME=YOUR_USERNAME BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY npm test