globalShortcut

在应用程序未获得键盘焦点时检测键盘事件。

进程：主进程

globalShortcut 模块可以向操作系统注册/注销全局键盘快捷键，以便您可以为各种快捷键自定义操作。

注意

快捷键是全局的；即使应用程序没有键盘焦点，它也会起作用。此模块不能在 app 模块的 ready 事件发出之前使用。另请注意，也可以使用 Chromium 的 GlobalShortcutsPortal 实现，该实现允许应用程序在 Wayland 会话中运行时绑定全局快捷键。

const { app, globalShortcut } = require('electron')

// Enable usage of Portal's globalShortcuts. This is essential for cases when
// the app runs in a Wayland session.
app.commandLine.appendSwitch('enable-features', 'GlobalShortcutsPortal')

app.whenReady().then(() => {
  // Register a 'CommandOrControl+X' shortcut listener.
  const ret = globalShortcut.register('CommandOrControl+X', () => {
    console.log('CommandOrControl+X is pressed')
  })

  if (!ret) {
    console.log('registration failed')
  }

  // Check whether a shortcut is registered.
  console.log(globalShortcut.isRegistered('CommandOrControl+X'))
})

app.on('will-quit', () => {
  // Unregister a shortcut.
  globalShortcut.unregister('CommandOrControl+X')

  // Unregister all shortcuts.
  globalShortcut.unregisterAll()
})

方法

globalShortcut 模块具有以下方法

globalShortcut.register(accelerator, callback)

• accelerator Accelerator
• callback Function

返回 boolean - 快捷键是否已成功注册。

注册 accelerator 的全局快捷键。当用户按下已注册的快捷键时，会调用 callback。

当加速键已被其他应用程序占用时，此调用将静默失败。这是操作系统预期的行为，因为它们不希望应用程序争夺全局快捷键。

以下加速键在 macOS 10.14 Mojave 上除非应用程序已被授权为 受信任的辅助功能客户端，否则将无法成功注册

• "Media Play/Pause"
• "Media Next Track"
• "Media Previous Track"
• "Media Stop"

globalShortcut.registerAll(accelerators, callback)

• accelerators Accelerator[] - 一个 Accelerator 数组。
• callback Function

注册 accelerators 中所有 accelerator 项的全局快捷键。当按下任何已注册的快捷键时，会调用 callback。

当给定的加速键已被其他应用程序占用时，此调用将静默失败。这是操作系统预期的行为，因为它们不希望应用程序争夺全局快捷键。

以下加速键在 macOS 10.14 Mojave 上除非应用程序已被授权为 受信任的辅助功能客户端，否则将无法成功注册

• "Media Play/Pause"
• "Media Next Track"
• "Media Previous Track"
• "Media Stop"

globalShortcut.isRegistered(accelerator)

• accelerator Accelerator

返回 boolean - 此应用程序是否已注册 accelerator。

当加速键已被其他应用程序占用时，此调用仍将返回 false。这是操作系统预期的行为，因为它们不希望应用程序争夺全局快捷键。

globalShortcut.unregister(accelerator)

• accelerator Accelerator

注销 accelerator 的全局快捷键。

globalShortcut.unregisterAll()

注销所有全局快捷键。