键盘快捷键

配置本地和全局键盘快捷键

本地快捷键

您可以使用 [Menu] 模块来配置快捷键,只有在 app 处于焦点状态时才可以触发快捷键。 为此,在创建 MenuItem时必须指定一个 [accelerator] 属性。

  1. const { Menu, MenuItem } = require('electron')
  2. const menu = new Menu()
  3. menu.append(new MenuItem({
  4. label: 'Print',
  5. accelerator: 'CmdOrCtrl+P',
  6. click: () => { console.log('time to print stuff') }
  7. }))

你还可以在操作系统中配置不同的组合键。

  1. {
  2. accelerator: process.platform === 'darwin' ? 'Alt+Cmd+I' : 'Ctrl+Shift+I'
  3. }

全局快捷键

当应用程序不处于焦点状态时,你可以使用 globalShortcut 模块来检测键盘事件,

  1. const { app, globalShortcut } = require('electron')
  2. app.whenReady().then(() => {
  3. globalShortcut.register('CommandOrControl+X', () => {
  4. console.log('CommandOrControl+X is pressed')
  5. })
  6. })

在浏览器窗口内的快捷方式

如果你想处理 BrowserWindow中的键盘快捷键,你可以监听渲染进程中 window 对象的 keyupkeydown 事件。

  1. window.addEventListener('keyup', doSomething, true)

注意第三个参数 true,这意味着当前监听器总是在其他监听器之前接收按键,以避免其它监听器调用 stopPropagation()

在调度页面中的keydownkeyup事件之前,会发出before-input-event事件。 它可以用于捕获和处理在菜单中不可见的自定义快捷方式。

如果您不想手动进行快捷键解析,可以使用一些库来进行高级的按键检测。例如 mousetrap.

  1. Mousetrap.bind('4', () => { console.log('4') })
  2. Mousetrap.bind('?', () => { console.log('show shortcuts!') })
  3. Mousetrap.bind('esc', () => { console.log('escape') }, 'keyup')
  4. // 组合
  5. Mousetrap.bind('command+shift+k', () => { console.log('command shift k') })
  6. // 将多个组合映射到相同的回调
  7. Mousetrap.bind(['command+k', 'ctrl+k'], () => {
  8. console.log('command k or control k')
  9. // 返回 false 以防止默认行为,并阻止事件冒泡
  10. return false
  11. })
  12. // gmail 风格序列
  13. Mousetrap.bind('g i', () => { console.log('go to inbox') })
  14. Mousetrap.bind('* a', () => { console.log('select all') })
  15. // konami 代码
  16. Mousetrap.bind('up up down down left right left right b a enter', () => {
  17. console.log('konami code')
  18. })