Package Exports

ink-progress-bar

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ink-progress-bar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ProgressBar

The ProgressBar component represents progress. See examples/progress.js for an example app. Run it with ./examples/run progress

Install

npm install --save ink-progress-bar

Usage

const {h, Text} = require('ink');
const ProgressBar = require('ink-progrss-bar');

<ProgressBar
    char="x"
    progress={0.5}
    left={5}
    right={0}
    green
/>

Props

character

The character to use for each item in the ProgressBar. Defaults to █ (block).

progress

The percentage (between 0 and 1) of progress in the ProgressBar.

left/right

The number of characters to subtract from each side of the ProgressBar. examples/progress.js demonstrates this. Commonly used if you want text before/after the progress bar on the same line.

{color}

Pass any chalk colors (e.g. green, bgBlue), similar to Text.

...

Any other props are passed to Text as-is.