rambar
v1.1.3
Published
Rambar is a Node.js module that allows you to create customizable progress bars with emojis. This module is designed to make it easy to display progress in a fun and engaging way.
Downloads
20
Maintainers
Readme
Rambar Module
Rambar is a Node.js module that allows you to create customizable progress bars with emojis. This module is designed to make it easy to display progress in a fun and engaging way.
Installation
To use Rambar in your project, you can install it via npm:
npm i rambar
Usage
Here's how you can use the Rambar module in your JavaScript code:
const { Rambar } = require('rambar');
const rambar = new Rambar({
width: 20,
blankEmoji: "Empty emoji (middle)",
filledEmoji: "Filled emoji (middle)",
blankFirstEdge: "Empty emoji (start)",
filledFirstEdge: "Filled emoji (start)",
blankLastEdge: "Empty emoji (end)",
filledLastEdge: "Filled emoji (end)"
})
// To get the progress bar, use the 'bar' property
const progressBar = rambar.bar;
Make sure to customize the emojis and options according to your preferences.
Options
width:
The width of the progress bar.blankEmoji:
The emoji to use for empty spaces in the middle of the bar.filledEmoji:
The emoji to use for filled spaces in the middle of the bar.blankFirstEdge:
The emoji to use for empty spaces at the start of the bar.filledFirstEdge:
The emoji to use for filled spaces at the start of the bar.blankLastEdge:
The emoji to use for empty spaces at the end of the bar.filledLastEdge:
The emoji to use for filled spaces at the end of the bar.
Licanse
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.