2023-03-29 19:02:13 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
|
|
|
|
|
|
<head>
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
<title>Keyboard Shortcuts</title>
|
|
|
|
</head>
|
|
|
|
|
|
|
|
<body>
|
|
|
|
<div>
|
|
|
|
<h1>Keyboard Shortcuts</h1>
|
|
|
|
|
|
|
|
<h3>The <code>globalShortcut</code> and <code>Menu</code> modules can be used to define keyboard shortcuts.</h3>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
In Electron, keyboard shortcuts are called accelerators.
|
|
|
|
They can be assigned to actions in your application's Menu,
|
|
|
|
or they can be assigned globally so they'll be triggered even when
|
|
|
|
your app doesn't have keyboard focus.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Open the full documentation for the
|
2023-08-10 09:55:52 +00:00
|
|
|
<a href="https://www.electronjs.org/docs/latest/api/menu">Menu</a>,
|
|
|
|
<a href="https://www.electronjs.org/docs/latest/api/accelerator">Accelerator</a>,
|
2023-03-29 19:02:13 +00:00
|
|
|
and
|
2023-08-10 09:55:52 +00:00
|
|
|
<a href="https://www.electronjs.org/docs/latest/api/global-shortcut">globalShortcut</a>
|
2023-03-29 19:02:13 +00:00
|
|
|
APIs in your browser.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<div>
|
|
|
|
<div>
|
|
|
|
<p>
|
|
|
|
To try this demo, press <kbd>CommandOrControl+Alt+K</kbd> on your
|
|
|
|
keyboard.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Global shortcuts are detected even when the app doesn't have
|
|
|
|
keyboard focus, and they must be registered after the app's
|
|
|
|
`ready` event is emitted.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<h2>ProTip</h2>
|
|
|
|
<strong>Avoid overriding system-wide keyboard shortcuts.</strong>
|
|
|
|
<p>
|
|
|
|
When registering global shortcuts, it's important to be aware of
|
|
|
|
existing defaults in the target operating system, so as not to
|
|
|
|
override any existing behaviors. For an overview of each
|
|
|
|
operating system's keyboard shortcuts, view these documents:
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
<li><a
|
2023-08-10 09:55:52 +00:00
|
|
|
href="https://developer.apple.com/design/human-interface-guidelines/keyboards">macOS</a>
|
2023-03-29 19:02:13 +00:00
|
|
|
</li>
|
|
|
|
<li><a
|
2023-08-10 09:55:52 +00:00
|
|
|
href="https://support.microsoft.com/en-us/windows/keyboard-shortcuts-in-windows-dcc61a57-8ff0-cffe-9796-cb9706c75eec">Windows</a></li>
|
2023-03-29 19:02:13 +00:00
|
|
|
<li><a
|
2023-08-10 09:55:52 +00:00
|
|
|
href="https://developer.gnome.org/hig/guidelines/keyboard.html">Linux</a></li>
|
2023-03-29 19:02:13 +00:00
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</body>
|
|
|
|
|
|
|
|
</html>
|