Browse Source

Merge pull request #4988 from atom/accelerator-docs

use example accelerators that align with best practices
Cheng Zhao 9 years ago
parent
commit
a9ea8b92f0
2 changed files with 7 additions and 7 deletions
  1. 2 2
      docs/api/accelerator.md
  2. 5 5
      docs/api/global-shortcut.md

+ 2 - 2
docs/api/accelerator.md

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

+ 5 - 5
docs/api/global-shortcut.md

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