native-progress-bar

This module allows your Electron app to display native dialogs with progress bars in them on Windows and macOS. It has no dependencies other than binding and creates a ~85KB Node addon.

To see various examples for progress bars, check out test/src/progress-bars.js.

Screenshots

Application required (macOS)

On macOS, the module only works in Node.js environments that run within a proper application (like Electron). It therefore does not run in simple Node.js scripts that you might execute with node myscript.js.

API

1import { ProgressBar } from "native-progress-bar"
2
3let progressBar, interval;
4
5// All arguments are optional
6progressBar = new ProgressBar({
7  // Window title
8  title: "Running disk operation",
9  // Message, shown above the progress bar
10  message: "Running format C:",
11  // Initial progress value
12  progress: 0,
13  // Can be "hud", "utility", or "default". Only of effect on macOS.
14  style: "hud"
15  // Zero or more buttons
16  buttons: [{
17    label: "Cancel",
18    click: (progressBar) => {
19      console.log("Cancel button clicked");
20      progressBar.close();
21    }
22  }],
23  // A function called when the dialog is closed. Useful to cleanup intervals.
24  onClose: () => {
25    clearInterval(interval);
26  },
27});
28
29interval = setInterval(() => {
30  if (progressBar.progress >= 100) {
31    clearInterval(interval);
32
33    // You can dynamically change buttons
34    progressBar.buttons = [{
35      label: "Done",
36      click: (progressBar) => {
37        console.log("Done button clicked");
38        progressBar.close();
39      }
40    }]
41
42    return
43  }
44
45  progressBar.progress += 1;
46}, 200);

What about Linux?

I didn't need Linux but I'd welcome PRs implementing it there.