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

Merge pull request #4988 from atom/accelerator-docs

Browse source 
use example accelerators that align with best practices
This commit is contained in:
Cheng Zhao 2016-04-03 14:03:32 +09:00
commit a9ea8b92f0
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/accelerator.md
View file

@ -5,8 +5,8 @@ multiple modifiers and key codes, combined by the `+` character.
Examples: Examples:
* `Command+A` * `CommandOrControl+A`
* `Ctrl+Shift+Z` * `CommandOrControl+Shift+Z`
## Platform notice ## Platform notice

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

@ -14,9 +14,9 @@ const app = electron.app;
const globalShortcut = electron.globalShortcut; const globalShortcut = electron.globalShortcut;
app.on('ready', function() { app.on('ready', function() {
// Register a 'ctrl+x' shortcut listener. // Register a 'CommandOrControl+X' shortcut listener.
var ret = globalShortcut.register('ctrl+x', function() { var ret = globalShortcut.register('CommandOrControl+X', function() {
console.log('ctrl+x is pressed'); console.log('CommandOrControl+X is pressed');
}); });
if (!ret) { if (!ret) {
@ -24,12 +24,12 @@ app.on('ready', function() {
} }
// Check whether a shortcut is registered. // Check whether a shortcut is registered.
console.log(globalShortcut.isRegistered('ctrl+x')); console.log(globalShortcut.isRegistered('CommandOrControl+X'));
}); });
app.on('will-quit', function() { app.on('will-quit', function() {
// Unregister a shortcut. // Unregister a shortcut.
globalShortcut.unregister('ctrl+x'); globalShortcut.unregister('CommandOrControl+X');
// Unregister all shortcuts. // Unregister all shortcuts.
globalShortcut.unregisterAll(); globalShortcut.unregisterAll();