跳到主要内容

任务栏自定义

概览​

Electron 提供了 API 来配置应用在 Windows 任务栏中的图标。这个 API 支持 Windows 独有的功能，如创建 JumpList、自定义缩略图和工具栏、图标叠加层以及所谓的“闪烁窗口”效果，同时也支持跨平台功能，如最近文档和应用进度。

JumpList​

Windows 允许应用定义一个自定义上下文菜单，当用户右键点击应用在任务栏中的图标时会显示出来。该上下文菜单被称为 JumpList。您可以在 JumpList 的 Tasks 类别中指定自定义操作，引用自 MSDN

应用程序根据程序的功能以及用户期望通过它们完成的关键操作来定义任务。任务应该是无上下文的，也就是说，应用程序无需运行即可使它们工作。它们也应该是普通用户在应用程序中执行的统计上最常见的操作，例如在邮件程序中撰写电子邮件或打开日历，在文字处理器中创建新文档，以特定模式启动应用程序，或启动其某个子命令。应用程序不应在菜单中堆砌标准用户不需要的高级功能或一次性操作，例如注册。不要将任务用于推广项目，例如升级或特别优惠。

强烈建议任务列表是静态的。无论应用程序的状态如何，它都应该保持不变。虽然可以动态改变列表，但应考虑到这可能会让不期望目标列表部分发生变化的用户感到困惑。

Taskbar JumpList

注意：上面的截图是 Microsoft Edge 一般任务的示例

与 macOS 中的 Dock 菜单（这是一个真正的菜单）不同，Windows 中的用户任务就像应用程序快捷方式一样工作。例如，当用户点击一个任务时，程序将使用指定的参数执行。

要为您的应用程序设置用户任务，您可以使用 app.setUserTasks API。

示例​

设置用户任务​

从 教程启动代码 中的一个工作应用程序开始，使用以下行更新 main.js 文件

const { app } = require('electron')

app.setUserTasks([
  {
    program: process.execPath,
    arguments: '--new-window',
    iconPath: process.execPath,
    iconIndex: 0,
    title: 'New Window',
    description: 'Create a new window'
  }
])
清除任务列表​

要清除任务列表，您需要在 main.js 文件中使用一个空数组调用 app.setUserTasks。

const { app } = require('electron')

app.setUserTasks([])

注意：即使在关闭应用程序后，用户任务仍会显示，因此为任务指定的图标和程序路径应在卸载应用程序之前一直存在。

缩略图工具栏​

在 Windows 上，您可以将带有指定按钮的缩略图工具栏添加到应用程序窗口的任务栏布局中。它为用户提供了一种无需恢复或激活窗口即可访问特定窗口命令的方式。

引用自 MSDN

此工具栏是熟悉的标准工具栏通用控件。它最多包含七个按钮。每个按钮的 ID、图像、工具提示和状态都定义在一个结构中，然后传递给任务栏。应用程序可以根据其当前状态的需要，显示、启用、禁用或隐藏缩略图工具栏中的按钮。

例如，Windows Media Player 可能会提供标准的媒体传输控件，如播放、暂停、静音和停止。

Thumbnail toolbar

注意：上面的截图是 Windows Media Player 缩略图工具栏的示例

要在应用程序中设置缩略图工具栏，您需要使用 BrowserWindow.setThumbarButtons

示例​

设置缩略图工具栏​

从 教程启动代码 中的一个工作应用程序开始，使用以下行更新 main.js 文件

const { BrowserWindow, nativeImage } = require('electron')
const path = require('node:path')

const win = new BrowserWindow()

win.setThumbarButtons([
  {
    tooltip: 'button1',
    icon: nativeImage.createFromPath(path.join(__dirname, 'button1.png')),
    click () { console.log('button1 clicked') }
  }, {
    tooltip: 'button2',
    icon: nativeImage.createFromPath(path.join(__dirname, 'button2.png')),
    flags: ['enabled', 'dismissonclick'],
    click () { console.log('button2 clicked.') }
  }
])
清除缩略图工具栏​

要清除缩略图工具栏按钮，您需要在 main.js 文件中使用一个空数组调用 BrowserWindow.setThumbarButtons。

const { BrowserWindow } = require('electron')

const win = new BrowserWindow()
win.setThumbarButtons([])

任务栏图标叠加层​

在 Windows 上，任务栏按钮可以使用一个小型叠加层来显示应用程序状态。

引用自 MSDN

图标叠加层作为上下文状态通知，旨在消除使用单独的通知区域状态图标向用户传达信息的必要性。例如，Microsoft Outlook 中的新邮件状态目前在通知区域显示，现在可以通过任务栏按钮上的叠加层来指示。同样，您必须在开发周期中决定哪种方法最适合您的应用程序。叠加图标旨在提供重要、长期性的状态或通知，例如网络状态、即时通讯状态或新邮件。不应向用户呈现不断变化的叠加层或动画。

Overlay on taskbar button

注意：上面的截图是任务栏按钮叠加层的示例

要为窗口设置叠加图标，您需要使用 BrowserWindow.setOverlayIcon API。

示例​

从 教程启动代码 中的一个工作应用程序开始，使用以下行更新 main.js 文件

const { BrowserWindow, nativeImage } = require('electron')

const win = new BrowserWindow()

win.setOverlayIcon(nativeImage.createFromPath('path/to/overlay.png'), 'Description for overlay')

闪烁窗口​

在 Windows 上，您可以高亮任务栏按钮以引起用户注意。这类似于 macOS 中 Dock 图标的弹跳效果。

引用自 MSDN

通常，窗口闪烁是为了通知用户该窗口需要注意，但当前没有键盘焦点。

要使 BrowserWindow 任务栏按钮闪烁，您需要使用 BrowserWindow.flashFrame API。

示例​

从 教程启动代码 中的一个工作应用程序开始，使用以下行更新 main.js 文件

const { BrowserWindow } = require('electron')

const win = new BrowserWindow()

win.once('focus', () => win.flashFrame(false))
win.flashFrame(true)

注意：不要忘记调用 win.flashFrame(false) 来关闭闪烁。在上面的示例中，它在窗口获得焦点时调用，但您也可以使用超时或其他事件来禁用它。