progress_bar 0.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 59

progress_bar

Progress bar for dart command-line apps. A port of node-progress to Dart.

Usage

Basic usage:

var bar = new ProgressBar(' [:bar] :percent :etas ', total: 10);
var timer = new Timer.periodic(new Duration(seconds: 1), (Timer timer) {
  bar.tick();
  if (bar.complete) {
    timer.cancel();
  }
});

basic

Options

These are keys in the options you can pass to the progress bar along with total as seen in the example above.

  • total total number of ticks to complete
  • width the displayed width of the progress bar defaulting to total
  • complete completion character defaulting to "="
  • incomplete incomplete character defaulting to "-"
  • clear option to clear the bar on completion defaulting to false
  • callback optional function to call when the progress bar completes

Tokens

These are tokens you can use in the format of your progress bar.

  • :bar the progress bar itself
  • :current current tick number
  • :total total ticks
  • :elapsed time elapsed in seconds
  • :percent completion percentage
  • :eta estimated completion time in seconds

Features and bugs

Please file feature requests and bugs at the issue tracker.

Changelog

0.2.0

  • Fix compile error

0.1.1

  • Make options optional.
  • Add the optional callback function, which called when the progress bar completes.

0.1.0

  • Initial version.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  progress_bar: "^0.2.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:progress_bar/progress_bar.dart';
  
Version Uploaded Documentation Archive
0.2.0 Apr 16, 2018 Go to the documentation of progress_bar 0.2.0 Download progress_bar 0.2.0 archive
0.1.1 Dec 22, 2014 Go to the documentation of progress_bar 0.1.1 Download progress_bar 0.1.1 archive
0.1.0 Dec 20, 2014 Go to the documentation of progress_bar 0.1.0 Download progress_bar 0.1.0 archive

Analysis

We analyzed this package on Jun 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
18 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
59
Learn more about scoring.

Platforms

Detected platforms: Flutter, other

Primary library: package:progress_bar/progress_bar.dart with components: io.

Suggestions

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use progress_bar.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Run dartfmt to format lib/src/progress_bar.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.20.1 <2.0.0
Dev dependencies
test ^0.12.0