Skip to content

barbarbar338/generate-progressbar

Repository files navigation

stars license supportServer forks issues

Logo

Simple Progressbar

Create progressbar easily
Get support »

Report Bug · Request Feature

📦 Installation

  • Using yarn: yarn add generate-progressbar
  • Using npm: npm i generate-progressbar

🤓 Usage

import { generate } from "generate-progressbar";
const bar = generate(10, 50); // bar length: 10, percentage: 50%, total length: 12
// output [▓▓▓▓▓░░░░░]

using custom options

import { generate /* , IProgressbarOptions */ } from "generate-progressbar";
const options /* : IProgressbarOptions*/ = {
	empty: "-",
	end: "|",
	full: "+",
	seperator: "o",
	start: "|",
};
const bar = generate(10, 50); // bar length: 10, percentage: 50%, total length: 12
// output |++++o-----|

📄 License

Copyright © 2021 Barış DEMİRCİ.

Distributed under the GPL-3.0 License. See LICENSE for more information.

🧦 Contributing

Feel free to use GitHub's features.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/my-feature)
  3. Run prettier and eslint (npm run format && npm run lint)
  4. Commit your Changes (git commit -m 'my awesome feature my-feature')
  5. Push to the Branch (git push origin feature/my-feature)
  6. Open a Pull Request

🔥 Show your support

Give a ⭐️ if this project helped you!

📞 Contact