rohitedathil/consolebars

A dart library to create Progress Bars in console.

A package for creating an awesome progress bar in the terminal. Handy while developing a CLI or a desktop utility in dart.

See in pub.dev

Usage

Options:

• total : Total number of steps
• desc : Simple text shown before the bar (optional)
• space : Character denoting empty space (default : '.')
• fill : Character denoting filled space (default : '█')
• time : Toggle timing mode (default : false)
• percentage : Toggle percentage display (default : false)
• scale : Scale of the bar relative to width (between: 0 and 1, default: 0.5, Irrelavant if width is specified)
• width : Width of the bar (If not specified, it will be automatically calculated using the terminal width and scale)

Code:

final p = FillingBar(desc: "Loading", total: 1000, time: true, percentage:true);
  for (var i = 0; i < 1000; i++) {
    p.increment();
    sleep(Duration(milliseconds: 10));
  }

Result:

Loading : ████████████████████████████████████████.................... 673/1000 67.3% [ 0:00:13.28 / 0:00:06.45 ]

Note: You can use the total and desc setters to change the total number of steps and description mid-way.

consolebars's Issues

time: true makes the whole thing just stop

Hi there!
I tried using your bar. Very nice!

However, if i set time: true, my code doesn't execute at all :/ all i see is the time being nicely updated

Maybe you wanted to update it per-second, messed something with streams, and that's why. How about, the time updating only when you call .increment() 👀 ?

Cheers

how to run it ?

MacOs : StdoutException

Getting , Unhandled Exception: StdoutException: Could not get terminal size, OS Error: Inappropriate ioctl for device, errno = 25
on Macos M1

Allow total to be changed at runtime.

I have a progress bar where the total may change over time.

I propose a update to the API like so:

void update(int n) { ... }

to

void update(int n, {int? total}) { ... }

and then if I call update(1, total: 100) the total gets updated appropriately.

Alternatively there could be a new method to update the total, but it seems reasonable to always update the current progress and total at the same time.