github-forks
/
hotkeys
mirror of https://github.com/jaywcjlove/hotkeys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add some more detail to the README (#103)

Browse Source
pull/105/head
yakov116 6 years ago committed by 小弟调调™
parent 8baca96a82
commit 2119e8a06f
1 changed files with 86 additions and 54 deletions
Show Stats Download Patch File Download Diff File

140
README.md
Unescape Escape View File

@ -37,13 +37,18 @@ Or manually download and link **hotkeys.js** in your HTML, It can also be downlo
```html ```html
<script src="https://unpkg.com/hotkeys-js/dist/hotkeys.min.js"></script> <script src="https://unpkg.com/hotkeys-js/dist/hotkeys.min.js"></script>
<script type="text/javascript"> <script type="text/javascript">
hotkeys('ctrl+a,ctrl+b,r,f', function(event,handler) { hotkeys('ctrl+a,ctrl+b,r,f', function (event, handler){
switch(handler.key){ switch (handler.key) {
case "ctrl+a":alert('you pressed ctrl+a!');break; case 'ctrl+a': alert('you pressed ctrl+a!');
case "ctrl+b":alert('you pressed ctrl+b!');break; break;
case "r":alert('you pressed r!');break; case 'ctrl+b': alert('you pressed ctrl+b!');
case "f":alert('you pressed f!');break; break;
} case 'r': alert('you pressed r!');
break;
case 'f': alert('you pressed f!');
break;
default: alert(event);
}
}); });
</script> </script>
``` ```
@ -106,7 +111,7 @@ hotkeys('ctrl+r, command+r', function() {
return false; return false;
}); });
// SIngle key
hotkeys('a', function(event,handler){ hotkeys('a', function(event,handler){
//event.srcElement: input //event.srcElement: input
//event.target: input //event.target: input
@ -116,23 +121,28 @@ hotkeys('a', function(event,handler){
alert('you pressed a!') alert('you pressed a!')
}); });
hotkeys('ctrl+a,ctrl+b,r,f', function(event,handler) { // Key Combenation
switch(handler.key){ hotkeys('ctrl+a,ctrl+b,r,f', function (event, handler){
case "ctrl+a":alert('you pressed ctrl+a!');break; switch (handler.key) {
case "ctrl+b":alert('you pressed ctrl+b!');break; case 'ctrl+a': alert('you pressed ctrl+a!');
case "r":alert('you pressed r!');break; break;
case "f":alert('you pressed f!');break; case 'ctrl+b': alert('you pressed ctrl+b!');
} break;
case 'r': alert('you pressed r!');
break;
case 'f': alert('you pressed f!');
break;
default: alert(event);
}
}); });
hotkeys('ctrl+a+s', function(event,handler) { hotkeys('ctrl+a+s', function() {
if(handler.key === 'ctrl+a+s') {
alert('you pressed ctrl+a+s!'); alert('you pressed ctrl+a+s!');
}
}); });
hotkeys('*','wcj', function(e){ // Using a scope
console.log('do something',e); hotkeys('*','wcj', function(event){
console.log('do something', event);
}); });
``` ```
@ -146,7 +156,7 @@ hotkeys('*','wcj', function(e){
```js ```js
hotkeys('o, enter', { hotkeys('o, enter', {
scope: 'wcj', scope: 'wcj',
element: document.getElementById('warpper'), element: document.getElementById('wrapper'),
}, function(){ }, function(){
console.log('do something else'); console.log('do something else');
}); });
@ -159,23 +169,43 @@ Asterisk "*"
Modifier key judgments Modifier key judgments
```js ```js
hotkeys('*', function(e){ hotkeys('*', function() {
if(hotkeys.shift) console.log('shift is pressed!'); if (hotkeys.shift) {
if(hotkeys.ctrl) console.log('ctrl is pressed!'); console.log('shift is pressed!');
if(hotkeys.alt) console.log('alt is pressed!'); }
if(hotkeys.option) console.log('option is pressed!');
if(hotkeys.control) console.log('control is pressed!'); if (hotkeys.ctrl) {
if(hotkeys.cmd) console.log('cmd is pressed!'); console.log('ctrl is pressed!');
if(hotkeys.command) console.log('command is pressed!'); }
if (hotkeys.alt) {
console.log('alt is pressed!');
}
if (hotkeys.option) {
console.log('option is pressed!');
}
if (hotkeys.control) {
console.log('control is pressed!');
}
if (hotkeys.cmd) {
console.log('cmd is pressed!');
}
if (hotkeys.command) {
console.log('command is pressed!');
}
}); });
``` ```
### setScope ### setScope
Use the `hotkeys.setScope` method to set scope. Use the `hotkeys.setScope` method to set scope. There can only be one active scope besides 'all'. By default 'all' is always active.
```js ```js
// define shortcuts with a scope // Define shortcuts with a scope
hotkeys('ctrl+o, ctrl+alt+enter', 'issues', function(){ hotkeys('ctrl+o, ctrl+alt+enter', 'issues', function(){
console.log('do something'); console.log('do something');
}); });
@ -183,7 +213,7 @@ hotkeys('o, enter', 'files', function(){
console.log('do something else'); console.log('do something else');
}); });
// set the scope (only 'all' and 'issues' shortcuts will be honored) // Set the scope (only 'all' and 'issues' shortcuts will be honored)
hotkeys.setScope('issues'); // default scope is 'all' hotkeys.setScope('issues'); // default scope is 'all'
``` ```
@ -197,7 +227,7 @@ hotkeys.getScope();
### deleteScope ### deleteScope
Use the `hotkeys.deleteScope` method to delete set scope. Use the `hotkeys.deleteScope` method to delete a scope. This will also remove all associated hotkeys with it.
```js ```js
hotkeys.deleteScope('issues'); hotkeys.deleteScope('issues');
@ -211,8 +241,8 @@ Similar to defining shortcuts, they can be unbound using `hotkeys.unbind`.
// unbind 'a' handler // unbind 'a' handler
hotkeys.unbind('a'); hotkeys.unbind('a');
// unbind a hotkeys only for a single scope // Unbind a hotkeys only for a single scope
// when no scope is specified it defaults to the current scope (hotkeys.getScope()) // If no scope is specified it defaults to the current scope (hotkeys.getScope())
hotkeys.unbind('o, enter', 'issues'); hotkeys.unbind('o, enter', 'issues');
hotkeys.unbind('o, enter', 'files'); hotkeys.unbind('o, enter', 'files');
``` ```
@ -220,23 +250,24 @@ hotkeys.unbind('o, enter', 'files');
Unbind events through functions. Unbind events through functions.
```js ```js
function example(){} function example() {
hotkeys('a', example); hotkeys('a', example);
hotkeys.unbind('a', example); hotkeys.unbind('a', example);
hotkeys('a', 'issues', example); hotkeys('a', 'issues', example);
hotkeys.unbind('a', 'issues', example); hotkeys.unbind('a', 'issues', example);
}
``` ```
### isPressed ### isPressed
Other key queries. For example, `hotkeys.isPressed(77)` is true if the `M` key is currently pressed. For example, `hotkeys.isPressed(77)` is true if the `M` key is currently pressed.
```js ```js
hotkeys('a', function(){ hotkeys('a', function() {
console.log(hotkeys.isPressed("a")); //=> true console.log(hotkeys.isPressed('a')); //=> true
console.log(hotkeys.isPressed("A")); //=> true console.log(hotkeys.isPressed('A')); //=> true
console.log(hotkeys.isPressed(65)); //=> true console.log(hotkeys.isPressed(65)); //=> true
}); });
``` ```
@ -245,19 +276,20 @@ hotkeys('a', function(){
**key down** and **key up** both perform callback events. **key down** and **key up** both perform callback events.
```js ```js
hotkeys('ctrl+a,alt+a+s', { keyup: true }, (evn, handler) => { hotkeys('ctrl+a,alt+a+s', {keyup: true}, function(event, handler) {
if(evn.type === 'keydown') { if (event.type === 'keydown') {
console.log('keydown:', evn.type, handler, handler.key); console.log('keydown:', event.type, handler, handler.key);
} }
if(evn.type === 'keyup') {
console.log('keyup:', evn.type, handler, handler.key); if (event.type === 'keyup') {
} console.log('keyup:', event.type, handler, handler.key);
}
}); });
``` ```
### getPressedKeyCodes ### getPressedKeyCodes
returns an array of key codes currently pressed. Returns an array of key codes currently pressed.
```js ```js
hotkeys('command+ctrl+shift+a,f', function(){ hotkeys('command+ctrl+shift+a,f', function(){
@ -267,7 +299,7 @@ hotkeys('command+ctrl+shift+a,f', function(){
### filter ### filter
`INPUT` `SELECT` `TEXTAREA` default does not handle. By default hotkeys are not enabled for `INPUT` `SELECT` `TEXTAREA` elements.
`Hotkeys.filter` to return to the `true` shortcut keys set to play a role, `false` shortcut keys set up failure. `Hotkeys.filter` to return to the `true` shortcut keys set to play a role, `false` shortcut keys set up failure.
```js ```js

Write Preview
Loading…
Cancel
Save