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
ink-progress-bar
Progress bar component for Ink.
Install
$ npm install ink-progress-barUsage
See examples/basic.js for an example app. Run it with ./examples/run basic.
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
Default: '█'
The character to use for each step.
percent
Type: number
Default: 0
The percentage (between 0 and 1) of progress.
left
right
Type: number
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 for an example.
License
MIT © Frankie Bagnardi