Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitwalker/keys.js
Easy keybindings for browser applications!
https://github.com/bitwalker/keys.js
Last synced: 3 months ago
JSON representation
Easy keybindings for browser applications!
- Host: GitHub
- URL: https://github.com/bitwalker/keys.js
- Owner: bitwalker
- License: mit
- Created: 2013-06-21T17:09:33.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-03-09T18:51:44.000Z (over 8 years ago)
- Last Synced: 2024-03-21T01:01:31.224Z (3 months ago)
- Language: JavaScript
- Homepage: http://bitwalker.github.io/keys.js/
- Size: 7.77 MB
- Stars: 360
- Watchers: 17
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-frontend - Keys.js - 应用快捷键
- awesome-front-end - Keys.js - 应用快捷键
- awesome-frontend - Keys.js - 应用快捷键
- awesome-frontend - Keys.js - 应用快捷键
README
# Keys.js
For a quick look at the kind of solution that Keys.js is intended to provide, check out the [demo application](http://bitwalker.github.io/keys.js/examples/mail.html).
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](https://bitwalker.github.io/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