xprogress

Construct Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS

Features

• Stream management functionality

Installing

Via NPM:

npm install xprogress

Usage

// Node CommonJS
const ProgressBar = require('xprogress');
// Or ES6
import ProgressBar from 'xprogress';

Example

Create a basic progress bar that updates itself with 10% twice every second until it's maximum

const ProgressBar = require('xprogress');

const bar = new ProgressBar(100);

const interval = setInterval(() => {
  bar.tick(10).draw();
  if (bar.isComplete()) {
    bar.end(`The bar completed\n`);
    clearInterval(interval);
  }
}, 500);

How It Works

ProgressBar uses stringd to parse content within ProgressBar::template with variables in ProgressBar::variables and then displays them on the terminal. This sequence occurs for every time ProgressBar::draw() is called.

API

new ProgressBar(total[, slots][, opts])

• total: <number>
• slots: <HybridInput[]>
• opts: <[BarOpts][]>

Create and return an xprogress instance slots define the percentage to each part of the progressbar. This is parsed by pad-ratio to a max of 100.

const bar = new ProgressBar(100, [20, 44]);

GlobOpts: Object

• bar: Object
  • blank: <string> Content to use for the blank portion of the progressbar. Default: '-'.
  • filler: <string> Content to use for the filled portion of the progressbar. Default: '#'.
  • header: <string> Content to use for the header(s) of progressbars. Default: ''.
  • colorize: <boolean> Whether or not to allow colors in the bar. Default: true.
  • separator: <string> Content to use when separating bars. Default: ''.
  • pulsateSkip: <number> Distance away at which to skip a pulsating bar. Default: 15.
  • pulsateLength: <number> The length of a pulsating progressbar. Default: 15.
• clean: <boolean> Whether or not to clear the progressbar buffer on the terminal after ProgressBar::end() has been called. Default: false.
• flipper: <string|string[]> Content(s) to use for the progressbar flipper. This would cycle through all indexes in this property for everywhere :{flipper} is speified. Default: ['|', '/', '-', '\'].
• pulsate: <boolean> Whether or not to use a pulsate view for the progressbar. Default: false.
• template: <string|string[]> The template to use for the progressbar view. This is parsed by stringd. with this.variables Default: ''.
• variables: <VariableOpts> Variables with which to parse this.template, extended with cStringd.raw.
• forceFirst: <boolean> Whether or not to force a multi-bar progressbar to a single bar (useful either when terminal width is too small or when filled with excess addons). Default: false.

The global options shared by both ProgressBar ProgressStream.

PreVariableOpts _{extends cStringd.raw}: Object

• bar: <> Hey. Default: ``
• label: <> Hey. Default: ``
• total: <> Hey. Default: ``
• completed: <> Hey. Default: ``
• remaining: <> Hey. Default: ``
• percentage: <> Hey. Default: ``

VariableOpts _{extends PreVariableOpts}: Object

• label: <any> The bar. Default: ``
• : <> Hey. **Default**:
• : <> Hey. **Default**:
• : <> Hey. **Default**:

HybridInput: string|number|number[]

This content here is parsed by pad-ratio in the construct of an [HybridInput][hybridratio].

Development

Building

Feel free to clone, use in adherance to the license and perhaps send pull requests

git clone https://github.com/miraclx/xprogress.git
cd xprogress
npm install
# hack on code
npm run build

License

Apache 2.0 © Miraculous Owonubi (@miraclx) <omiraculous@gmail.com>