57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# global-shortcut
|
|
|
|
The `global-shortcut` module can register/unregister a global keyboard shortcut
|
|
with the operating system, so that you can customize the operations for various shortcuts.
|
|
Note that the shortcut is global; it will work even if the app does not have the keyboard focus.
|
|
You should not use this module until the `ready` event of the app module is emitted.
|
|
|
|
```javascript
|
|
var app = require('app');
|
|
var globalShortcut = require('global-shortcut');
|
|
|
|
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');
|
|
}
|
|
|
|
// Check whether a shortcut is registered.
|
|
console.log(globalShortcut.isRegistered('ctrl+x'));
|
|
});
|
|
|
|
app.on('will-quit', function() {
|
|
// Unregister a shortcut.
|
|
globalShortcut.unregister('ctrl+x');
|
|
|
|
// Unregister all shortcuts.
|
|
globalShortcut.unregisterAll();
|
|
});
|
|
```
|
|
|
|
## globalShortcut.register(accelerator, callback)
|
|
|
|
* `accelerator` [Accelerator](accelerator.md)
|
|
* `callback` Function
|
|
|
|
Registers a global shortcut of `accelerator`. The `callback` is called when
|
|
the registered shortcut is pressed by the user.
|
|
|
|
## globalShortcut.isRegistered(accelerator)
|
|
|
|
* `accelerator` [Accelerator](accelerator.md)
|
|
|
|
Returns `true` or `false` depending on whether the shortcut `accelerator` is registered.
|
|
|
|
## globalShortcut.unregister(accelerator)
|
|
|
|
* `accelerator` [Accelerator](accelerator.md)
|
|
|
|
Unregisters the global shortcut of `keycode`.
|
|
|
|
## globalShortcut.unregisterAll()
|
|
|
|
Unregisters all the global shortcuts.
|