πŸ“ Ascii progress-bar(s) in the terminal.
JavaScript
Latest commit 26c1a41 Dec 16, 2016 @bubkoo publish to npm
Permalink
Failed to load latest commit information.
examples examples Apr 16, 2016
.editorconfig editorconfig Mar 8, 2016
.gitignore gitignore Mar 8, 2016
.npmignore ignore snapshot Mar 8, 2016
LICENSE Initial commit Mar 2, 2016
README.md embed badges Sep 27, 2016
index.js Fix: case when stdout did not have rows/columns Oct 18, 2016
package.json publish to npm Dec 16, 2016
snapshot.gif snapshot Mar 8, 2016

README.md

ascii-progress

Ascii progress-bar(s) in the terminal.

MIT License Package Quality

Feature:

  • Support multi progress-bars
  • Relative and absolute with
  • Colorful bar and text
  • Highly customizable

snapshot

Install

$ npm install ascii-progress

Usage

For more usage see the examples

var ProgressBar = require('ascii-progress');

var bar = new ProgressBar({ 
    schema: ':bar',
    total : 10 
});

var iv = setInterval(function () {
  bar.tick();
  if (bar.completed) {
    clearInterval(iv);
  }
}, 100);

Options

These are keys in the options object you can pass to the progress bar along with total as seen in the example above.

  • schema - template string of the progress bar. Default " [:bar] :current/:total :percent :elapseds :etas'".
  • total - total number of ticks to complete. Default 100.
  • current- number of completed ticks. Default 0.
  • width - display width, percentage or less than 1 is relative the terminal's width. Default options.total.
  • filled- completion character. Default "β–‡".
  • blank - blank character. Default "-".
  • clear - clear the progress bar on completion. Default false.
  • callback - optional function to call when the progress bar completes.

Properties

  • schema
  • total
  • current
  • completed

Methods

setSchema(schema, refresh/tokens)

Update the schema of the progress bar. If refresh or tokens is truely the progress bar will be refreshed.

tick(delta, tokens)

Update ticks of the progress bar by delta, then render the progress bar with optional tokens.

update(ratio, tokens)

Update the progress bar to ratio by percentage, then render the progress bar with optional tokens.

clear()

Clean the progress bar in the terminal.

Schema

The schema defines appearance the progress bar. Few inner tokens and many formatting methods can be used to customer you progress bar.

Tokens

These are tokens you can use in the format of your progress bar.

  • :filled Completed part of the progress bar.
  • :blank Blank part of the progress bar.
  • :bar Whole progress bar, equal to :completed:blank.
  • :current Current tick number.
  • :total Total ticks.
  • :percent Completion percentage.
  • :elapsed Time elapsed in seconds.
  • :eta Estimated completion time in seconds.

Custom Tokens

You can define custom tokens by adding a {name: value} object parameter to your method (tick(), update(), etc.) calls.

var bar = new ProgressBar({
    schema: ':current: :token1 :token2',
    total : 3 
});
bar.tick({
  'token1': "Hello",
  'token2': "World!"
})
bar.tick(2, {
  'token1': "Goodbye",
  'token2': "World!"
})

The above example would result in the output below.

1: Hello World!
3: Goodbye World!

Colors

Color names can be use in schema:

:bar.red :percent.green

Then the progress bar will be red, and the percentage will be green.

All available color names:

  • red
  • cyan
  • blue
  • grey
  • white
  • black
  • green
  • yellow
  • magenta
  • brightRed
  • brightBlue
  • brightCyan
  • brightWhite
  • brightBlack
  • brightGreen
  • brightYellow
  • brightMagenta

And with the bg prefix, such as bgRed, the color will be applied to the background.

:bar.red.bgBlue

The above progress bar has blue background and red foreground.

Gradient

:bar.gradient(red,blue)

The arguments can be color names or hex color:

  • red
  • cyan
  • blue
  • grey
  • white
  • black
  • green
  • yellow
  • magenta
  • #xxxxxx

Font style

Same as color names, font style can also be assigned by name:

  • bold
  • italic
  • inverse
  • underline
:bar.red :percent.green.bold

The percentage is green and bold.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.