Multiple key combinations using javascript

Keyboard Shortcut class can be used to bind functions to custom key combinations.

It is also possible to provide interval for callback function to be recalled (until releasing key combination), if key combination was pressed and held.

Package contains kb_shortcut.js and kb_shortcut.packed.js (packed javascript)and 3 example files: simple_example.html (showing example of how to bind function to custom key combination), example.html (possible usages of this class) and squario.html(some sort of Mario game parody, using square div as Mario).

Download
Example codes
Examples in action
Method list
Supported Key/Button values
Latest changes
Rate us
Support

Download

Back to contents

JS classes - Keyboard Shortcut class

Example codes

Back to contents

<html>
<head>
</head>
<body>
<h1 style='text-align: center;'>Just try pressing Ctr+Alt+A</h1>
<script type="text/javascript" src="./kb_shortcut.js" ></script>
<script type="text/javascript">
var kb = new kb_shortcut();
kb.add(["Ctrl", "Alt", "A"], function(){
    alert("Key combination activated");
})
</script>
</body>
</html>

Examples in action

Back to contents

Example scripts provided with package in action:

Method list

Back to contents

Constructor
Bind function to key combination

Constructor

Back to method list

Method name	new kb_shortcut()
Description	Create Keyboard Shortcut instance

Bind function to key combination

Back to method list

Method name

add(keys, callback, hold, stop)

Description

Adds provided function to provided keyboard combination using provided configuration

Input parameters

string or array keys - One key/button name as string or multiple keys/buttons as arrays

function callback - which function to call, when provided combination is pressed

int hold (optional) - how often to call callback function if combination is pressed and not released (default: 0, disables repeated calls)

bool stop - try to prevent default event behavoir. It is only possible to prevent in website events, not browser defined events. (default: false)

Supported Key/Button values

Back to contents

List of all key/button names, that can be passed to add method creating key combinations

Description	Values	Example
Letters	A - Z	G
Numbers	0 - 9	3
Function keys	F1 - F12	F7
Space key	Space	Space
Enter/Return key	Enter	Enter
Tab key	Tab	Tab
Backspace key	Backspace	Backspace
Shift key	Shift	Shift
Control key	Ctrl	Ctrl
Alt key	Alt	Alt
Caps Lock key	Caps Lock	Caps Lock
Num Lock key	Num Lock	Num Lock
Arrows	Up, Right, Down, Left	Right
Insert key	Ins	Ins
Delete key	Del	Del
Home key	Home	Home
End key	End	End
Page up key	Page up	Page up
Page down key	Page down	Page down
Other symbols	"+", "-", "*", "/", ";", "=", ",", ".", "`", "[", "", "]", "'"	=