# react-top-progress-bar

> A progress bar displayed on top of page

Latest version **1.0.33** (published 2019-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-top-progress-bar
pnpm add react-top-progress-bar
yarn add react-top-progress-bar
bun add react-top-progress-bar
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.33 |
| Published | 2019-07-25 |
| First published | 2019-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Emanuele Scarabattoli |
| Maintainers | emanuelescarabattoli |
| Keywords | react, progress, bar, top, loading |

## Links

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

## 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

- 1.0.33 (latest) — 2019-07-25
- 1.0.32 — 2019-07-25
- 1.0.31 — 2019-07-25
- 1.0.30 — 2019-07-25
- 1.0.29 — 2019-07-25
- 1.0.28 — 2019-01-23
- 1.0.27 — 2019-01-23
- 1.0.26 — 2019-01-22
- 1.0.25 — 2019-01-22
- 1.0.24 — 2019-01-22
- 1.0.23 — 2019-01-22
- 1.0.21 — 2019-01-22
- 1.0.20 — 2019-01-21
- 1.0.19 — 2019-01-21
- 1.0.18 — 2019-01-21
- … 17 more at https://npm.io/package/react-top-progress-bar/versions

## README

# React Top Progress Bar
Adds a progress bar displayed on top of your page. When value changes, an **animation** is performed. When value is less or equal to 0 or greater than or equal to 100 the progress bar will **disappear automatically**

## Demo
You can find a demo [here](https://emanuelescarabattoli.github.io/react-top-progress-bar/)

## Installation
First you need to install the package as dependency by running the following command

`yarn add react-top-progress-bar`

## Usage
Then you can the progress bar in your component as described above:
```
import React, { Component } from "react";
import ReactTopProgressBar from "react-top-progress-bar";


class Demo extends Component {
  render() {
    return (
      <div >
        <ReactTopProgressBar value={50} />
      </div>
    );
  }
}

export default Demo;
```

## List of allowed props and defaults
Here a list of allowed props and related default values

| prop            | default value | behavior                          |
|-----------------|---------------|-----------------------------------|
| value           | 0             | Value, in percentage, of progress |
| color           | #CC0000       | Color of progress bar             |
| backgroundColor | transparent   | Background color of progress bar  |
| withShadow      | false         | The progress will have a shadow   |
| striped         | false         | Striped animated scrollbar        |

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