# scroll-progress-react

> page scroll progress bar

Latest version **0.1.4** (published 2017-02-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install scroll-progress-react
pnpm add scroll-progress-react
yarn add scroll-progress-react
bun add scroll-progress-react
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2017-02-10 |
| First published | 2016-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Calum Peak |
| Maintainers | echoes221 |
| Keywords | scroll, progress, react, react-component, bar, page |

## Links

- npm: https://www.npmjs.com/package/scroll-progress-react
- Repository: https://github.com/echoes221/scroll-progress-react
- Homepage: https://github.com/echoes221/scroll-progress-react#readme
- Issues: https://github.com/echoes221/scroll-progress-react/issues
- npm.io page: https://npm.io/package/scroll-progress-react

## Dependencies (1)

- [lodash.assign](https://npm.io/package/lodash.assign.md) ^4.2.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2017-02-10
- 0.1.3 — 2016-11-22
- 0.1.2 — 2016-11-20
- 0.1.1 — 2016-11-20
- 0.1.0 — 2016-11-20

## README

# scroll-progress-react
[![Build Status](https://travis-ci.org/echoes221/scroll-progress-react.svg?branch=master)](https://travis-ci.org/echoes221/scroll-progress-react)

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

###Getting Started
```
$ npm install scroll-progress-react
```

###In React
```
import React, { Component } from 'react';
import ScrollProgress from 'scroll-progress-react`;

class Demo extends Component {
  render () {
    return (<ScrollProgress />);
  }
}

export default Demo;
```
###Props

prop | Type | Default
-----|------|--------
style| Object | 
className | String | scroll-progress-react
  
Due to the nature of HTML5 progress bars, prefer to use CSS files select by the above class name.

---
_Source: https://npm.io/package/scroll-progress-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._