Skip to content
A simple fully customizable responsive stylish progress bar.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
res
test
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE
README.md
app.js
package-lock.json
package.json

README.md

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

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.