crimson-progressbar

1.3.0 • Public • Published

Crimson ProgressBar

A simple fully customizable responsive stylish progress bar.

Example

Example of Progress Bar

Function Help

renderProgressBar takes two parameters minimum the rest is optional:

  • currentValue
  • totalValue
  • progressColor
  • backgroundColor
  • progressSymbol (one char max)
  • backgroundSymbol (one char max)
  • renderContainer (show [] around progress bar = bool)
  • progressSize (string see below)

Colors Available

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white
  • gray
  • grey

Progess Bar Size

Here are the sizes you can pass to the progressSize they will all be responsive

  • "xsmall"
  • "small"
  • "medium"
  • "large"
  • "xlarge"

Code Example

to render one line simplys do the following:

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(50, 100);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(50, 100, "magenta", "cyan", "|", "|", false, "large");

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(50, 100, "red", "grey", "-", "=");

Example of Progress Bar

Styling Examples

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "magenta", "cyan", "|", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "magenta", "cyan", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "magenta", "cyan", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "magenta", "cyan", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "cyan", "cyan", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "green", "red", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "green", "red", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "green", "red", "", "", false);

Example of Progress Bar

const crimsonProgressBar = require("crimson-progressbar");
crimsonProgressBar.renderProgressBar(currentValue, totalValue, "green", "red", "", "", false);

Example of Progress Bar

install

npm i crimson-progressbar

Downloadsweekly downloads

5

version

1.3.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability