跳至主要内容

键盘快捷键

概述​

此功能允许您为 Electron 应用程序配置本地和全局键盘快捷键。

示例​

本地快捷键​

只有当应用程序获得焦点时，才会触发本地键盘快捷键。要配置本地键盘快捷键，您需要在 菜单 模块中创建 MenuItem 时指定 accelerator 属性。

从 快速入门指南 中获取一个可运行的应用程序，更新 main.js 为

docs/fiddles/features/keyboard-shortcuts/local (33.0.1)在 Fiddle 中打开
const { app, BrowserWindow, Menu, MenuItem } = require('electron/main')

function createWindow () {
  const win = new BrowserWindow({
    width: 800,
    height: 600
  })

  win.loadFile('index.html')
}

const menu = new Menu()
menu.append(new MenuItem({
  label: 'Electron',
  submenu: [{
    role: 'help',
    accelerator: process.platform === 'darwin' ? 'Alt+Cmd+I' : 'Alt+Shift+I',
    click: () => { console.log('Electron rocks!') }
  }]
}))

Menu.setApplicationMenu(menu)

app.whenReady().then(createWindow)

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow()
  }
})

注意：在上面的代码中，您可以看到加速器根据用户的操作系统而有所不同。对于 MacOS，它是 Alt+Cmd+I，而对于 Linux 和 Windows，它是 Alt+Shift+I。

启动 Electron 应用程序后，您应该会看到应用程序菜单以及您刚刚定义的本地快捷键。

Menu with a local shortcut

如果您点击“帮助”或按下定义的加速键，然后打开运行 Electron 应用程序的终端，您将看到触发 click 事件后生成的“Electron rocks！”消息。

全局快捷键​

要配置全局键盘快捷键，您需要使用 globalShortcut 模块来检测键盘事件，即使应用程序没有键盘焦点。

从 快速入门指南 中获取一个可运行的应用程序，更新 main.js 为

docs/fiddles/features/keyboard-shortcuts/global (33.0.1)在 Fiddle 中打开
const { app, BrowserWindow, globalShortcut } = require('electron/main')

function createWindow () {
  const win = new BrowserWindow({
    width: 800,
    height: 600
  })

  win.loadFile('index.html')
}

app.whenReady().then(() => {
  globalShortcut.register('Alt+CommandOrControl+I', () => {
    console.log('Electron loves global shortcuts!')
  })
}).then(createWindow)

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow()
  }
})

注意：在上面的代码中，CommandOrControl 组合在 macOS 上使用 Command，在 Windows/Linux 上使用 Control。

启动 Electron 应用程序后，如果您按下定义的键组合，然后打开运行 Electron 应用程序的终端，您将看到 Electron loves global shortcuts！

BrowserWindow 中的快捷键​

使用 Web API​

如果您想在 BrowserWindow 中处理键盘快捷键，您可以使用 addEventListener() API 在渲染器进程中监听 keyup 和 keydown DOM 事件。

docs/fiddles/features/keyboard-shortcuts/web-apis (33.0.1)在 Fiddle 中打开
function handleKeyPress (event) {
  // You can put code here to handle the keypress.
  document.getElementById('last-keypress').innerText = event.key
  console.log(`You pressed ${event.key}`)
}

window.addEventListener('keyup', handleKeyPress, true)

注意：第三个参数 true 表示侦听器将始终在其他侦听器之前接收按键，因此无法在其上调用 stopPropagation()。

在主进程中拦截事件​

在页面中分派 keydown 和 keyup 事件之前，会发出 before-input-event 事件。它可以用来捕获和处理菜单中不可见的自定义快捷键。

从 快速入门指南 中获取一个可运行的应用程序，使用以下几行更新 main.js 文件。

docs/fiddles/features/keyboard-shortcuts/interception-from-main (33.0.1)在 Fiddle 中打开
const { app, BrowserWindow } = require('electron/main')

app.whenReady().then(() => {
  const win = new BrowserWindow({ width: 800, height: 600 })

  win.loadFile('index.html')
  win.webContents.on('before-input-event', (event, input) => {
    if (input.control && input.key.toLowerCase() === 'i') {
      console.log('Pressed Control+I')
      event.preventDefault()
    }
  })
})

启动 Electron 应用程序后，如果您打开运行 Electron 应用程序的终端并按下 Ctrl+I 键组合，您将看到此键组合已成功拦截。

使用第三方库​

如果您不想手动解析快捷键，有一些库可以进行高级键检测，例如 mousetrap。以下是 mousetrap 在渲染器进程中使用的示例。

Mousetrap.bind('4', () => { console.log('4') })
Mousetrap.bind('?', () => { console.log('show shortcuts!') })
Mousetrap.bind('esc', () => { console.log('escape') }, 'keyup')

// combinations
Mousetrap.bind('command+shift+k', () => { console.log('command shift k') })

// map multiple combinations to the same callback
Mousetrap.bind(['command+k', 'ctrl+k'], () => {
  console.log('command k or control k')

  // return false to prevent default behavior and stop event from bubbling
  return false
})

// gmail style sequences
Mousetrap.bind('g i', () => { console.log('go to inbox') })
Mousetrap.bind('* a', () => { console.log('select all') })

// konami code!
Mousetrap.bind('up up down down left right left right b a enter', () => {
  console.log('konami code')
})