:memo: app commands
authorPaul Betts <paul@paulbetts.org>
Fri, 19 Jun 2015 19:58:47 +0000 (12:58 -0700)
committerPaul Betts <paul@paulbetts.org>
Thu, 25 Jun 2015 17:29:25 +0000 (11:29 -0600)
docs/api/browser-window.md

index b9c78b9..31e7ca5 100644 (file)
@@ -219,6 +219,23 @@ Emitted when devtools is closed.
 
 Emitted when devtools is focused / opened.
 
+### Event: 'app-command' (Windows):
+
+Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows.
+
+
+```js
+AppCommands = require('app-command');
+
+someWindow.on('app-command', function(e, cmd) => {
+  // Navigate the window back when the user hits their mouse back button
+  if (cmd === AppCommands.APPCOMMAND_BROWSER_BACKWARD &&
+      someWindow.webContents.canGoBack()) {
+    someWindow.webContents.goBack();
+  }
+});
+```
+
 ### Class Method: BrowserWindow.getAllWindows()
 
 Returns an array of all opened browser windows.