react-page-progress

# react-page-progress

> Sweet Component (Yes, This is the one with HOOKS 🚀) that tracks a users progress through a page as they scroll

[![NPM](https://img.shields.io/npm/v/react-page-progress.svg)](https://www.npmjs.com/package/react-page-progress) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm i react-page-progress
```

OR

```bash
yarn add react-page-progress
```

## Usage

![Example Code](/src/demo/code.png?raw=true)

## Props

| Props  |  Type  | isRequired | Example                                                                                                                                            |
| :----- | :----: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------- |
| color  | string |     No     | `'Default is SkyBlue'`, `'green'` or `'#fb6249'` or ` 'rgb(255, 26, 26)'``// If you want Progress bar Opaque, You can use rgba(...) or hsla(...) ` |
| height | number |     No     | `'Should be a Number, 4 is default'`                                                                                                               |

### Demo

**Watch Demo [Here](https://nomangul.github.io/react-page-progress)**

## License

MIT © [NomanGul](https://github.com/NomanGul)


React library that tracks a users progress through a page as they scroll. 

React library that tracks a users progress through a page as they scroll

react-page-progress