react-page-scroll-progress-bar
Advanced tools
Comparing version 1.0.14 to 1.0.15
{ | ||
"name": "react-page-scroll-progress-bar", | ||
"version": "1.0.14", | ||
"version": "1.0.15", | ||
"description": "Page scroll progress bar", | ||
@@ -5,0 +5,0 @@ "main": "dist/", |
@@ -29,7 +29,23 @@ # React Page Scroll Progress Bar | ||
import PageScrollProgressBar from "react-page-scroll-progress-bar"; | ||
``` | ||
Pass the reference of the parent most HTML element of your react app. for eg - | ||
Required props: | ||
| Parameter | Description | | ||
|:----------|:---------------------------------------------------------------------------| | ||
| AppRef | The reference (useRef) of the parent most HTML element of your react app. |the score from the classifier for each C position | ||
Optional props: | ||
| Parameter | Default | Description | | ||
|:--------------------|:----------------:| :-------------| | ||
| progressBarColor | #eb5757 |Color of the progress bar as a hex string | ||
| progressBarBgColor | #f2f2f2 |Color of the progress bar background as a hex string | ||
| progressBarHeight | 0.25rem or 4px |Height of the progress bar | ||
####Example - | ||
```bash | ||
@@ -42,3 +58,3 @@ | ||
return ( | ||
<PageScrollProgressBar AppRef={AppRef} /> | ||
<PageScrollProgressBar AppRef={AppRef} progressBarColor="#00FFFF" progressBarBgColor="#f2f2f2" progressBarHeight="6px" /> | ||
<div className="App" ref={AppRef}> | ||
@@ -45,0 +61,0 @@ APP |
5453
73