Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added progress bar utility #290

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

onmax
Copy link
Contributor

@onmax onmax commented Apr 11, 2024

πŸ”— Linked issue

N/A

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Added a new progress bar with a simple API:

Code_brhx94nBXf.mp4

I tried to make the API simple, but any feedback is welcome. Let me know if you would like to improve something!

const prog = progress({
	message: 'Your initial message' // Message next to the bar. Default to ''
	showPercentage: true, // Whether to show percentage after the bar or not. Default to false
	width: 50, // How many characters long. Default to 25
});

prog.update(0.5 /* value between 0 and 1*/, { message: 'Your new optional message' }) 

prog.stop() // Complete the bar and add new line

P.S. At the moment I am importing the function directly in the example because I am not completely sure how to

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@onmax onmax mentioned this pull request Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant