react-content-progress-bar
v2.4.1
Published
An useful Progress Bar for blogs and content reading
Downloads
58
Maintainers
Readme
React Content Progress Bar
Adaptative Progress Bar for all usage ! ✨
Simple to use and to implement for your blog or website
Usage
Import the ProgressBar:
import ProgressBar from "react-content-progress-bar";
You have seven parameters available:
backgroundColor
: Color of the progress bar background- default: transparent
callback
: Function to be called when the progress bar reaches the end- default: () => {}
color
: Color of the progress bar- default: white
ref
: The Ref of the content you want to cover (ie. blog post, article..). (See https://reactjs.org/docs/refs-and-the-dom.html)- REQUIRED
radius
(previouslyborderRadius
): Radius of the right border side (top-right and bottom-right) (in px)- default: 0
style
: Style of the progress bar (solid, dashed, dotted..)- default: solid
thickness
(previouslywidth
): Thickness of the progress bar (in px)- default: 1
Use it like this:
<ProgressBar
backgroundColor="rgba(125, 125, 125, 0.8)"
callback={() => console.log("Reached the end of my document")}
color="#fff"
radius={2}
ref={this.myRef}
style="solid"
thickness={3}
/>
License
MIT © Lorris Saint-Genez