github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2164 from hankbao/global-shortcut-doc-update

Browse Source 
Update global-shortcut.md
This commit is contained in:
Cheng Zhao
2015-07-10 13:33:07 +08:00
parent 5ae57baf11 fc9612a5ed
commit a24d2921af
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/api/global-shortcut.md
View File

@@ -3,25 +3,33 @@
The `global-shortcut` module can register/unregister a global keyboard shortcut
in operating system, so that you can customize the operations for various shortcuts.
Note that the shortcut is global, even if the app does not get focused, it will still work.
You should not use this module until the ready event of app module gets emitted.
```javascript
var app = require('app');
var globalShortcut = require('global-shortcut');
// Register a 'ctrl+x' shortcut listener.
var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); })
app.on('ready', function() {
// Register a 'ctrl+x' shortcut listener.
var ret = globalShortcut.register('ctrl+x', function() {
console.log('ctrl+x is pressed');
})
if (!ret) {
console.log('registration failed');
}
if (!ret) {
console.log('registration failed');
}
// Check whether a shortcut is registered.
console.log(globalShortcut.isRegistered('ctrl+x'));
// Check whether a shortcut is registered.
console.log(globalShortcut.isRegistered('ctrl+x'));
});
// Unregister a shortcut.
globalShortcut.unregister('ctrl+x');
app.on('will-quit', function() {
// Unregister a shortcut.
globalShortcut.unregister('ctrl+x');
// Unregister all shortcuts.
globalShortcut.unregisterAll();
// Unregister all shortcuts.
globalShortcut.unregisterAll();
});
```
## globalShortcut.register(accelerator, callback)