electron-progressbar

electron-progressbar provides an easy-to-use and highly customizable API to show and control progress bars on Electron applications.

You can customize the aspects of the windows (electron's BrowserWindow), progress bars' visual aspects (CSS), texts and also all visible information.

Demo

Indeterminate progress bar:

Determinate progress bar: Additionally, as of electron-progressbar v1.1.0, a progress bar is automatically added to the taskbar (through BrowserWindow's setProgressBar). This enables a window to provide progress information to the user without the user having to switch to the window itself.

taskbar for indeterminate progress bar:

taskbar for determinate progress bar:

Table of Contents

• Installation
• Examples
  • Indeterminate progress bar
  • Determinate progress bar
  • More examples
• API
  • Methods
    • .new ProgressBar(options, [electronApp])
    • .getOptions() ⇒ object
    • .on(eventName, listener) ⇒ reference to this
      • Events
        • ready
        • progress
        • completed
        • aborted
    • .setCompleted()
    • .close()
    • .isInProgress() ⇒ boolean
    • .isCompleted() ⇒ boolean
  • Properties
    • value ⇒ number
    • text ⇒ string
    • detail ⇒ string
• License

Installation

Install with npm:

$ npm install electron-progressbar --save

Examples

Indeterminate progress bar

Example of an indeterminate progress bar - used when your application can't calculate how long the task will last:

const {app} = require('electron');
const ProgressBar = require('electron-progressbar');

app.on('ready', function() {
  var progressBar = new ProgressBar({
    text: 'Preparing data...',
    detail: 'Wait...'
  });
  
  progressBar
    .on('completed', function() {
      console.info(`completed...`);
      progressBar.detail = 'Task completed. Exiting...';
    })
    .on('aborted', function() {
      console.info(`aborted...`);
    });
  
  // launch a task...
  // launchTask();
  
  // when task is completed, set the progress bar to completed
  // ps: setTimeout is used here just to simulate an interval between the start and the end of a task
  setTimeout(function() {
    progressBar.setCompleted();
  }, 3000);
});

Determinate progress bar

Example of a determinate progress bar - used when your application can accurately calculate how long the task will last:

const {app} = require('electron');
const ProgressBar = require('electron-progressbar');

app.on('ready', function() {
  var progressBar = new ProgressBar({
    indeterminate: false,
    text: 'Preparing data...',
    detail: 'Wait...'
  });
  
  progressBar
    .on('completed', function() {
      console.info(`completed...`);
      progressBar.detail = 'Task completed. Exiting...';
    })
    .on('aborted', function(value) {
      console.info(`aborted... ${value}`);
    })
    .on('progress', function(value) {
      progressBar.detail = `Value ${value} out of ${progressBar.getOptions().maxValue}...`;
    });
  
  // launch a task and set the value of the progress bar each time a part of the task is done;
  // the progress bar will be set as completed when it reaches its maxValue (default maxValue: 100);
  // ps: setInterval is used here just to simulate a task being done
  setInterval(function() {
    if(!progressBar.isCompleted()){
      progressBar.value += 1;
    }
  }, 20);
});

More examples in folder examples.

API

Methods

new ProgressBar(options, [electronApp])

Create a new progress bar. Because electron's BrowserWindow is used to display the progress bar and it only works after electron's "ready" event, you have wait for the "ready" event before creating a progress bar; optionally, you can just pass electron's app as a second parameter (electronApp).

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | object | | electron-progressbar options | | [options.abortOnError] | boolean | false | Whether progress bar should abort and close if an error occurs internally. | | [options.indeterminate] | boolean | true | Whether progress bar should be indeterminate. If false, progress bar will be determinate. | | [options.initialValue] | number | 0 | Progress bar's initial value. Used only for determinate progress bar. | | [options.maxValue] | number | 100 | Progress bar's maximum value. When progress bar's value reaches this number, it will be set as completed and event complete will be fired. Used only for determinate progress bar. | | [options.closeOnComplete] | boolean | true | Whether progress bar window should be automatically closed after completed. If false, the progress bar must be manually closed by calling its close method. | | [options.title] | string | 'Wait...' | Text shown on title bar. | | [options.text] | string | 'Wait...' | Text shown inside the window and above the progress bar. | | [options.detail] | string | | Text shown between text and the progress bar element. Used to display the current status, i.e., what part of the whole task is being done. Usually setting this property later is more useful because your application can determine and display, in real time, what is currently happening. | | [options.style] | object | | Visual styles for elements: text, detail, bar and value. All elements' properties are purely CSS, just the way it is used in a CSS file. | | [options.style.text] | object | | An object containing any CSS properties for styling the text element. | | [options.style.detail] | object | | An object containing any CSS properties for styling the detail element. | | [options.style.bar] | object | {'width':'100%', 'background-color':'#BBE0F1'} | An object containing any CSS properties for styling the bar in the progress bar. | | [options.style.value] | object | {'background-color':'#0976A9'} | An object containing any CSS properties for styling the value in the progress bar. | | [options.browserWindow] | object | | Electron's BrowserWindow options. Although only a few properties are used per default, you can specify any of Electron's BrowserWindow options. | | [options.browserWindow.parent] | instance of BrowserWindow | null | A BrowserWindow instance. If informed, the progress bar window will always show on top of the parent window and will block it so user can't interact with it until the progress bar is completed/aborted and closed. | | [options.browserWindow.modal] | boolean | true | Whether this is a modal window. This actually only works if progress bar window is a child window, i.e., when its parent is informed. | | [options.browserWindow.resizable] | boolean | false | Whether window is resizable. | | [options.browserWindow.closable] | boolean | false | Whether window is closable. | | [options.browserWindow.minimizable] | boolean | false | Whether window is minimizable. | | [options.browserWindow.maximizable] | boolean | false | Whether window is maximizable. | | [options.browserWindow.width] | number | 450 | Progress bar window's width in pixels. | | [options.browserWindow.height] | number | 175 | Progress bar window's height in pixels. |

getOptions() ⇒ object

Return a copy of all current options.

on(eventName, listener) ⇒ reference to this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Returns a reference to this so that calls can be chained.

Events

| Event name | Receives parameter | Description | | --- | --- | --- | | ready | | Fired when progress bar is created and ready to be used and controlled. | | progress | value | Available only for determinate progress bar. Fired every time the progress bar's value is changed. The listener receives, as first parameter, the current progress bar's value. | | completed | value | Fired when progress bar is completed, i.e., its value reaches maxValue or method complete is called. The listener receives, as first parameter, the current progress bar's value. | | aborted | value | Fired if progress bar is closed when it's not completed yet, i.e., when user closes progress bar window or method close is called before progress bar is completed. The listener receives, as first parameter, the current progress bar's value. |

setCompleted()

Set progress bar as complete. This means the whole task is finished.

If progress bar is indeterminate, a manual call to this method is required because it's the only way to complete the task and trigger the complete event, otherwise the progress bar would be displayed forever.

close()

Close progress bar window. If progress bar is not completed yet, it'll be aborted and event aborted will be fired.

isInProgress() ⇒ boolean

Return true if progress bar is currently in progress, i.e., it hasn't been completed nor aborted yet, otherwise false.

isCompleted() ⇒ boolean

Return true if progress bar is completed, otherwise false.

Properties

value ⇒ number

Get or set progress bar's value. Only available for determinate progress bar.

text ⇒ string

Get or set the text. This information is shown inside the window and above the progress bar.

detail ⇒ string

Get or set the detail. This information is shown between text and the progress bar element. Useful to display the current status in real time, i.e., what part of the whole task is being done, what is currently happening.

License

MIT. See LICENSE.md for details.