跳转到主要内容

进度条

概述

进度条使窗口能够在无需切换到窗口本身的情况下向用户提供进度信息。

在 Windows 上,您可以使用任务栏按钮来显示进度条。

Windows Progress Bar

在 macOS 上,进度条将显示为 Dock 图标的一部分。

macOS Progress Bar

在 Linux 上,Unity 图形界面也具有类似的功能,允许您在启动器中指定进度条。

Linux Progress Bar

注意:在 Windows 上,每个窗口都可以有自己的进度条,而在 macOS 和 Linux (Unity) 上,应用程序只能有一个进度条。


所有三种情况都由相同的 API 覆盖 - BrowserWindow 实例上的 setProgressBar() 方法。要指示您的进度,请使用 01 之间的数字调用此方法。例如,如果您有一个正在进行的长时间运行的任务,目前已完成 63%,您将调用它,如 setProgressBar(0.63)

将参数设置为负值(例如 -1)将移除进度条。将其设置为大于 1 的值将在 Windows 中指示不确定进度条,或在其他操作系统中将其限制为 100%。不确定进度条保持活动状态,但不显示实际百分比,用于您不知道操作完成需要多长时间的情况。

请参阅 API 文档以获取更多选项和模式

示例

在此示例中,我们向主窗口添加一个进度条,该进度条使用 Node.js 定时器随时间递增。

const { app, BrowserWindow } = require('electron/main')

let progressInterval

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

win.loadFile('index.html')

const INCREMENT = 0.03
const INTERVAL_DELAY = 100 // ms

let c = 0
progressInterval = setInterval(() => {
// update progress bar to next value
// values between 0 and 1 will show progress, >1 will show indeterminate or stick at 100%
win.setProgressBar(c)

// increment or reset progress bar
if (c < 2) {
c += INCREMENT
} else {
c = (-INCREMENT * 5) // reset to a bit less than 0 to show reset state
}
}, INTERVAL_DELAY)
}

app.whenReady().then(createWindow)

// before the app is terminated, clear both timers
app.on('before-quit', () => {
clearInterval(progressInterval)
})

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

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

启动 Electron 应用程序后,Dock (macOS) 或任务栏 (Windows, Unity) 应显示一个进度条,该进度条从零开始,进展到 100% 完成。然后它应该显示不确定状态(Windows)或固定在 100%(其他操作系统)短暂时间,然后循环。

macOS dock progress bar

对于 macOS,当使用 Mission Control 时,您的应用程序也会显示进度条。

Mission Control Progress Bar