ink-progress-bar

3.0.0 • Public • Published

ink-progress-bar

Build Status

Progress bar component for Ink.

Install

$ npm install ink-progress-bar

Usage

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

Readme

Keywords

none

Package Sidebar

Install

npm i ink-progress-bar

Weekly Downloads

6,796

Version

3.0.0

License

MIT

Unpacked Size

6.49 kB

Total Files

5

Last publish

Collaborators

  • greenjello