Tray

类: Tray

在系统通知区域添加图标和上下文菜单。

进程: 主进程

Tray 是一个 EventEmitter。

const { app, Menu, Tray } = require('electron')

let tray = null
app.whenReady().then(() => {
  tray = new Tray('/path/to/my/icon')
  const contextMenu = Menu.buildFromTemplate([
    { label: 'Item1', type: 'radio' },
    { label: 'Item2', type: 'radio' },
    { label: 'Item3', type: 'radio', checked: true },
    { label: 'Item4', type: 'radio' }
  ])
  tray.setToolTip('This is my application.')
  tray.setContextMenu(contextMenu)
})

警告

Electron 的内置类不能在用户代码中被子类化。欲了解更多信息，请参阅 常见问题解答。

平台注意事项

Linux

• 托盘图标默认使用 StatusNotifierItem，当用户桌面环境中不可用时，将使用 GtkStatusIcon。
• 当托盘图标收到用户激活时会触发 click 事件，但 StatusNotifierItem 规范并未明确规定何种操作会触发激活，对于某些环境可能是鼠标左键单击，但对于另一些环境则可能是鼠标左键双击。
• 为了使对单个 MenuItem 所做的更改生效，您必须再次调用 setContextMenu。例如

const { app, Menu, Tray } = require('electron')

let appIcon = null
app.whenReady().then(() => {
  appIcon = new Tray('/path/to/my/icon')
  const contextMenu = Menu.buildFromTemplate([
    { label: 'Item1', type: 'radio' },
    { label: 'Item2', type: 'radio' }
  ])

  // Make a change to the context menu
  contextMenu.items[1].checked = false

  // Call this again for Linux because we modified the context menu
  appIcon.setContextMenu(contextMenu)
})

macOS

• 传递给 Tray 构造函数的图标应为 模板图像。
• 为确保您的图标在 Retina 显示器上不出现颗粒感，请确保您的 @2x 图像为 144dpi。
• 如果您正在打包应用程序（例如，使用 webpack 进行开发），请确保文件名未被混淆或哈希化。文件名需要以 Template 结尾，并且 @2x 图像需要与标准图像具有相同的文件名，否则 macOS 将不会自动反转图像颜色或使用高密度图像。
• 16x16 (72dpi) 和 32x32@2x (144dpi) 适用于大多数图标。

Windows

• 建议使用 ICO 图标以获得最佳视觉效果。

new Tray(image, [guid])

• image (NativeImage | string)
• guid string (可选) Windows - 为托盘图标分配一个 GUID。如果可执行文件已签名并且签名主题行中包含组织信息，则该 GUID 将永久与该签名关联。操作系统级别设置（如托盘图标在系统托盘中的位置）将保留，即使可执行文件的路径发生变化。如果可执行文件未进行代码签名，则 GUID 将永久与可执行文件的路径关联。更改可执行文件的路径将导致托盘图标创建失败，并且必须使用新的 GUID。但是，强烈建议仅在与代码签名的可执行文件结合使用时才使用 GUID 参数。如果一个应用程序定义了多个托盘图标，则每个图标都必须使用单独的 GUID。

创建一个与 image 关联的新托盘图标。

实例事件

Tray 模块发出以下事件

事件: 'click'

返回值

• event KeyboardEvent
• bounds Rectangle - 托盘图标的边界。
• position Point - 事件发生的位置。

当托盘图标被点击时触发。

请注意，在 Linux 上，当托盘图标被激活时会触发此事件，这可能不一定是鼠标左键单击。

事件: 'right-click' macOS Windows

返回值

• event KeyboardEvent
• bounds Rectangle - 托盘图标的边界。

当托盘图标被右键点击时触发。

事件: 'double-click' macOS Windows

返回值

• event KeyboardEvent
• bounds Rectangle - 托盘图标的边界。

当托盘图标被双击时触发。

事件: 'middle-click' Windows

返回值

• event KeyboardEvent
• bounds Rectangle - 托盘图标的边界。

当托盘图标被中键点击时触发。

事件: 'balloon-show' Windows

当托盘气球显示时触发。

事件: 'balloon-click' Windows

当托盘气球被点击时触发。

事件: 'balloon-closed' Windows

当托盘气球因超时或用户手动关闭而关闭时触发。

事件: 'drop' macOS

当任何拖拽的项目被放置到托盘图标上时触发。

事件: 'drop-files' macOS

返回值

• event 事件
• files string[] - 被拖放文件的路径。

当拖拽的文件被放置到托盘图标中时触发。

事件: 'drop-text' macOS

返回值

• event 事件
• text string - 被拖放的文本字符串。

当拖拽的文本被放置到托盘图标中时触发。

事件: 'drag-enter' macOS

当拖拽操作进入托盘图标区域时触发。

事件: 'drag-leave' macOS

当拖拽操作离开托盘图标区域时触发。

事件: 'drag-end' macOS

当拖拽操作在托盘上或在其他位置结束时触发。

事件: 'mouse-up' macOS

返回值

• event KeyboardEvent
• position Point - 事件发生的位置。

当鼠标从点击托盘图标后松开时触发。

注意

如果您使用 tray.setContextMenu 为托盘设置了上下文菜单，则此事件将不会触发，这是 macOS 层面限制导致的。

事件: 'mouse-down' macOS

返回值

• event KeyboardEvent
• position Point - 事件发生的位置。

当鼠标点击托盘图标时触发。

事件: 'mouse-enter' macOS Windows

返回值

• event KeyboardEvent
• position Point - 事件发生的位置。

当鼠标进入托盘图标区域时触发。

事件: 'mouse-leave' macOS Windows

返回值

• event KeyboardEvent
• position Point - 事件发生的位置。

当鼠标离开托盘图标区域时触发。

事件: 'mouse-move' macOS Windows

返回值

• event KeyboardEvent
• position Point - 事件发生的位置。

当鼠标在托盘图标区域内移动时触发。

实例方法

Tray 类有以下方法

tray.destroy()

立即销毁托盘图标。

tray.setImage(image)

• image (NativeImage | string)

设置与此托盘图标关联的 image。

tray.setPressedImage(image) macOS

• image (NativeImage | string)

在 macOS 上按下时，设置与此托盘图标关联的 image。

tray.setToolTip(toolTip)

• toolTip string

为此托盘图标设置悬停文本。将文本设置为空字符串将删除工具提示。

tray.setTitle(title[, options]) macOS

• title string
• options Object (可选)
  • fontType string (可选) - 要显示的字体家族变体，可以是 monospaced 或 monospacedDigit。monospaced 在 macOS 10.15+ 中可用。留空时，标题将使用默认系统字体。

设置状态栏中托盘图标旁边显示的标题（支持 ANSI 颜色）。

tray.getTitle() macOS

返回 string - 状态栏中托盘图标旁边显示的标题

tray.setIgnoreDoubleClickEvents(ignore) macOS

• ignore boolean

设置选项以忽略双击事件。忽略这些事件使您能够检测托盘图标的每一次单独点击。

此值默认为 false。

tray.getIgnoreDoubleClickEvents() macOS

返回 boolean - 是否会忽略双击事件。

tray.displayBalloon(options) Windows

• options Object
  • icon (NativeImage | string) (可选) - 当 iconType 为 custom 时使用的图标。
  • iconType string (可选) - 可以是 none、info、warning、error 或 custom。默认值为 custom。
  • title string
  • content string
  • largeIcon boolean (可选) - 应使用图标的大版本。默认值为 true。对应 NIIF_LARGE_ICON。
  • noSound boolean (可选) - 不播放关联的声音。默认值为 false。对应 NIIF_NOSOUND。
  • respectQuietTime boolean (可选) - 如果当前用户处于“安静时间”，则不显示气球通知。默认值为 false。对应 NIIF_RESPECT_QUIET_TIME。

显示一个托盘气球。

tray.removeBalloon() Windows

移除一个托盘气球。

tray.focus() Windows

将焦点返回到任务栏通知区域。通知区域图标在完成其 UI 操作后应使用此消息。例如，如果图标显示一个快捷菜单，但用户按下 ESC 取消它，请使用 tray.focus() 将焦点返回到通知区域。

tray.popUpContextMenu([menu, position]) macOS Windows

• menu Menu (可选)
• position Point (可选) - 弹出位置。

弹出托盘图标的上下文菜单。当传入 menu 时，将显示 menu 而不是托盘图标的上下文菜单。

position 参数仅在 Windows 上可用，默认值为 (0, 0)。

tray.closeContextMenu() macOS Windows

关闭由 tray.setContextMenu() 设置的打开的上下文菜单。

tray.setContextMenu(menu)

• menu Menu | null

为此图标设置上下文菜单。

tray.getBounds() macOS Windows

返回 Rectangle

此托盘图标的 bounds 以 Object 形式返回。

tray.isDestroyed()

返回 boolean - 托盘图标是否已被销毁。