跳至主要内容

任务栏自定义

概述​

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) 来关闭闪烁。在上面的示例中，它是在窗口获得焦点时调用的，但您可能使用超时或其他事件来禁用它。