mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update sample code in global-shortcut.md

Browse source
This commit is contained in:
Hank Bao 2015-07-09 17:03:58 +08:00
parent 7b19b6b4f2
commit fb99bfac52
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/api/global-shortcut.md
View file

@ -6,23 +6,30 @@ Note that the shortcut is global, even if the app does not get focused, it will
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) {
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)