1.1.1 ā€¢ Published 2 years ago

ms-react-progress-bar v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

MS REACT PROGRESS BAR

šŸŽ‰ Standalone Customizable React Progress bar NPM Downloads NPM License

ms-react-progress

Installation

npm install --save ms-react-progress-bar
yarn add ms-react-progress-bar

Features

  • Easy to set up
  • Super easy to customize
  • You can control the progress bar
  • Set your own maximum percentage
  • And much more !

Basic Usage

  import React from 'react';

  import { ProgressBar } from 'ms-react-progress-bar';
  import 'ms-react-progress-bar/dist/ProgressBar.css';
  
  function App(){

    return (
      <div>
        <ProgressBar value={40} />
      </div>
    );
  }

Adding Options

  import React from 'react';
  import { ProgressBar } from 'ms-react-progress-bar';
  import 'ms-react-progress-bar/dist/ProgressBar.css';
  
  function App(){
      const options = {
          height: "30px",
          borderRadius: "20px",
          labelSize: "14px",
          barColor: "#2c43ac",
          containerColor: "#dddddd",
          containerStyle: "border",
          stripeAnimation: true,
          stripeAnimationDuration: '20s',
          type: "striped",
      }
      return (
          <div>
              <ProgressBar value={80} options={options} />
          </div>
      );
  }

Demo

Examples

Documentation

Getting Started Guide

Props

PropsDescriptionDefault
valueNumber in percentage showing current progress0
optionsProgress Bar Options to help you customize0

Options

OptionDescriptionDefault
typeSpecify the type of progress bar. you can choose between regular, stripedregular
maxValueMaximum value in percentage showing end of progress. (number)100
heightHeight of Progress Bar in px15px
borderRadiusThe border radius of progress Bar in px10px
barColorThe hex color of the inner bar which show the current progress#2c43ac
stripeAnimationToggle striped animation on and off. should set type as "striped"false
stripeAnimationDurationDuration of stripe animation in seconds10s
containerStyleStyle of the outer container you can choose between bg,border,nonebg
containerColorColor of the outer container#dddddd
labelAlignmentThe alignment of the label choose between left, center, rightleft
labelSizeFont size of label12px
labelVisibilityToggle label on or offtrue
labelColorColor of labelwhite
customLabelAdd your own custom label

License

Licensed under MIT

1.1.1

2 years ago

1.1.0

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago