yckart/jquery.key.js

The certainly simpliest shortcut key event handler ever!

Something about

key.js is certainly the simpliest shortcut key event handler ever. As simple as I say it is to use!

The "plugin" was written to be small, useful and nothing more.

How to use

It is quite simple!

1st Include the script:

<script src='key.js'></script>

2nd Call the function:

key('your key', function() {
    // your function
});

3rd Press your key!

Examples

ESC

key('esc', function() {
    alert('esc');
});

CTRL + C

key('ctrl c', function() {
    alert('ctrl c');
});

CTRL + SHIFT + A

key('ctrl shift a', function() {
    alert('ctrl shift a');
});

Download

Get the raw script, download the complete package or fork it on GitHub.

Support

@yckart #keyjs http://yckart.com

Thanks

• http://unixpapa.com/js/key.html
• http://javascript.info/tutorial/keyboard-events

License

Copyright (c) 2012 Yannick Albert

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jquery.key.js's Issues

How to control play/pause key?

Hi there,

I'm using jKey for a project. Thank you for this amazing plug-in!
I currently work on a Macbook and wonder if you have the first row keys (brightness, volume, play/pause, etc.) assigned a name? It would be great if I can play with them as well. Thank you!

Command key not working

If I'm not mistaken, the command key should be "e.metaKey". Currently, if I press "cmd+enter" nothing happens
chrome + macos

Multiple keys

how can i check multiple separate key entries in one script? like using case or array..

ex: $.key(
"f1": function{}
"f2":function{}
.....
etc
)

How to bind keys from num pad ?

It seems I can not bind number pad keys on my keyboard. If you can please explain me how to add numer pad keys ?

: Just got it figured out.