bitwalker/keys.js

Easy keybindings for browser applications!

Keys.js

For a quick look at the kind of solution that Keys.js is intended to provide, check out the demo application.

This project spawned out of a Chrome extension I was working on where I kept handling more and more key combinations for shortcut actions, until it eventually became an unmaintainable rats nest. Obviously I needed a solution, and Keys.js was born.

Installation

$ npm install --save keys.js

Status

Stable, but it's a new project, so as always, caveat emptor. The documentation is very close to comprehensive, but some work needs to be done. The test suite is comprehensive, and very few gaps are left to fill there that are meaningful. Please help me identify any gaps in functionality, testing, or docs, by submitting issues so that I can prioritize things as needed. The current list of things I am working on is as follows:

• Implement locale selection, locale loading
• Implement Sequences (non-chord key combinations)
• Implement scoped bindings (only execute a binding if focus is within the scope of a given element)
• Comprehensive documentation (good progress already)
• Discover additional use cases that aren't covered as well as they could be
• Implement a faux-Vim example to demonstrate a complex usecase of keybindings in a web application.

Check out the Keys.js home page for information on browser support, dependencies, examples, and in-depth description of how Keys.js works.

License

MIT

See LICENSE file

keys.js's Issues

Simple bootstrap problem

When I resize my window the twitter bootstrap's css make the demo looks like this:

its very simple to solve, if you reorder the <link> tags it works.

I will submit a pull request for that!

webpack support?

Any plans to support Webpack?

If I include the library via bower, works as expected but using webpack I am getting the following error:

keys.js:959 
Uncaught TypeError: Cannot read property 'addEventListener' of undefined

it seems the library being loaded by webpack does not get initialized properly -- global is null

bower support?

Any plans for bower support?

CC BY-SA might be a bad idea

If you choose a copyleft license for software, please choose one that’s compatible with as many other licenses as possible. Unfortunately, that’s not the case for CC BY-SA (which, BTW, was probably not meant really for software where there are plenty of licenses already).

If you want a license with copyleft: you can choose, among others:

• Mozilla Public License version 2 (compatible with GNU GPLv3 and Apache License v2)
• GNU General Public License version 3
• or also the AGPL or the LGPL…

Demo page

Hey, what do you think about create a demo page! A github demo page would be great!

npm support?

Hi, great library, thanks for building it. Do you plan on adding npm support?