# ink-progress-bar

> a customizable progress bar for ink

Latest version **3.0.0** (published 2019-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install ink-progress-bar
pnpm add ink-progress-bar
yarn add ink-progress-bar
bun add ink-progress-bar
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2019-04-12 |
| First published | 2017-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Frankie Bagnardi |
| Maintainers | greenjello |

## Links

- npm: https://www.npmjs.com/package/ink-progress-bar
- npm.io page: https://npm.io/package/ink-progress-bar

## Dependencies (2)

- [blacklist](https://npm.io/package/blacklist.md) ^1.1.4
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Recent versions

- 3.0.0 (latest) — 2019-04-12
- 2.1.1 — 2018-01-29
- 2.1.0 — 2018-01-08
- 2.0.1 — 2017-08-29
- 2.0.0 — 2017-07-15
- 1.0.2 — 2017-07-09
- 1.0.1 — 2017-07-09
- 1.0.0 — 2017-07-09
- 0.1.0 — 2017-07-09

## README

# ink-progress-bar

[![Build Status](https://travis-ci.org/brigand/ink-progress-bar.svg?branch=master)](https://travis-ci.org/brigand/ink-progress-bar)

> Progress bar component for [Ink](https://github.com/vadimdemedes/ink).


## Install

```sh
$ npm install ink-progress-bar
```

## Usage

See [examples/basic.js](examples/basic.js) for an example app. Run it with `./examples/run basic`.

```jsx
import React, { Component } from 'react';
import { Color } from 'ink';
import ProgressBar from 'ink-progress-bar';

class MyProgress extends Component {
	render() {
		return (
			<>
				<Color red>
				<ProgressBar
					left={text.length}
					percent={this.state.done / TASKS}
				/>
				</Color>
			</>
		);
	}
}
```

## Props

All props except the ones below are passed to `<Text>` as-is.

### character

Type: `string`<br>
Default: `'█'`

The character to use for each step.

### percent

Type: `number`<br>
Default: `0`

The percentage (between 0 and 1) of progress.

### left
### right

Type: `number`<br>
Default: `0`

The number of characters to subtract from each side of the progress bar. Commonly used if you want text before/after the progress bar on the same line. See [examples/basic.js](examples/basic.js) for an example.


## License

MIT © [Frankie Bagnardi](https://github.com/brigand)

---
_Source: https://npm.io/package/ink-progress-bar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._