https://github.com/gillesdemey/cli-progress-bar

:clock9: A simple CLI progress bar, inspired by Gauge
https://github.com/gillesdemey/cli-progress-bar

Last synced: 3 days ago
JSON representation

:clock9: A simple CLI progress bar, inspired by Gauge

• Host: GitHub
• URL: https://github.com/gillesdemey/cli-progress-bar
• Owner: gillesdemey
• License: isc
• Created: 2015-10-15T00:56:41.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-09-06T08:46:34.000Z (about 8 years ago)
• Last Synced: 2024-10-13T02:08:50.986Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Usage

A simple CLI progress bar, inspired by Gauge.

```javascript

var ProgressBar = require('cli-progress-bar')

var bar = new ProgressBar()

bar.show("Foo", 0.75)

bar.pulse("bar")

bar.hide()

```

![screenshot 2015-10-15 02 58 33](https://cloud.githubusercontent.com/assets/868844/10502089/a7a483c0-72e8-11e5-90c8-1c2786639c49.png)

# API

### `var bar = new ProgressBar([options])`

* **options** – *(optional)* An option object.

The **options** object can have the following properties, all of which are

optional:

* theme: defaults to `ProgressBar.themes.unicode` if the terminal supports

  unicode according to [cli-character-set], otherwise it defaults to `ProgressBar.themes.ascii` or `ProgressBar.themes.cp437` for Windows.

* width: sets a desired width (in columns) of the entire progress indicator, not just the bar. The progress bar itself will take up about half of the column width. Additional text may overflow the desired with. By default it uses the number of available columns of the TTY.

### `bar.show([name, [completed]])`

* **name** – *(optional)* The name of the current thing contributing to progress. Defaults to the last value used, or "".

* **completed** – *(optional)* The portion completed as a value between 0 and 1. Defaults to the last value used, or 0.

### `bar.hide()`

Removes the progress bar from the terminal.

### `bar.pulse([name])`

* **name** – *(optional)* The specific thing that triggered this pulse

Spins the spinner in the progress bar to show output. If **name** is included then

it will be combined with the last name passed to `bar.show()` using the

subsection property of the theme (typically a right facing arrow).