keyboard-js

JavaScript Key Binding Library

Versión del día 22/9/2016. Echa un vistazo a la versión más reciente.

Este script no debería instalarse directamente. Es una biblioteca que utilizan otros scripts mediante la meta-directiva de inclusión // @require https://update.greasyfork.org/scripts/23404/148849/keyboard-js.js

Autor
creamidea
Versión
0.0.1.20160922234403
Creado
21/9/2016
Actualizado
22/9/2016
Tamaño
7,96 KB
Licencia
Desconocida

keyboard-js

A little library for keyboard binding. Now, it just supports chrome.

If you want to support more browsers or nodejs platform, just fork it.

Have fun, XD.

Usage

Full list of key values

Try it

Now, you can try it here. (source)

Quickly start

var Keyboard = require('keyboard-js').Keyboard
var keyboard = new Keyboard() // pay more attention: singal instance

// when you hit <kbd>Shift+b</kbd> or <kbd>Shift+e</kbd> will print `> test uk successfully`.
keyboard.registe('uk', function () {
    console.log('test uk successfully.')
}, ["Shift", "b"], ["Shift", "e"])

// start to listen
keyboard.start()

// have fun :)

Attention

Please pay more attention to the key combo. You should avoid the key conflict. For example, if you registe the Shortcut Key: Shift + B, you will be confused when you hit Shift + B in the textarea. So, be careful.

However, you can use API::Keyboard.end() to end when the textarea is focused and use API::Keyboard.start() to restart when it blurs. Also, you can discard the Shortcut Key: Shift + B.

API

Keyboard.start(): start to listen the keypress event
Keyboard.end():  end to listen keypress event and clean some resource
Keyboard.registe(name:String, callback:Function, [key1:String, key2:String,...], ...): registe the keyboard binding
Keyboard.unregiste(name:String): remove the register by name

LICENSE

MIT