react-step-progress-bar

react-step-progress-bar

  • Docs
  • Examples
  • GitHub

›API

Getting Started

  • Installation
  • First steps

Guide

  • Create your custom step
  • Create your own step transition

API

  • <Step/>
  • <ProgressBar/>

ProgressBar API

Here is the list of all the props of the <ProgressBar/> component.

name type default description
percent number Percantage of progression
children Step component(s) ProgressBar only accepts Step as children
stepPositions array of numbers By default Steps are spaced linearly on the ProgressBar. You can override this by specifying the positions of the steps (in percent)
unfilledBackground string rgba($color: lightgrey, $alpha: 0.6); This props is used directly on the CSS background property of the unfilled part of the ProgressBar.
filledBackground string rgba($color: #0074d9, $alpha: 0.8) This props is used directly on the CSS background property of the filled part of the ProgressBar
width (in pixel) number 100% The width of the progress bar in pixel
height (in pixel) number 10 The height of the progress bar in pixel
hasStepZero boolean true Tells if steps position should start at 0 or not
text string Add a text in the middle of the progress bar
← Step API
react-step-progress-bar
Docs
Getting StartedGuidesAPI ReferenceExamples
Community
MediumTwitter
More
GitHubStar
Made with 💘 by pierreericgarcia