# @rodrigowpl/react-progress

> Beautiful progress bar with React

Latest version **1.0.4** (published 2018-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rodrigowpl/react-progress
pnpm add @rodrigowpl/react-progress
yarn add @rodrigowpl/react-progress
bun add @rodrigowpl/react-progress
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2018-05-06 |
| First published | 2018-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 60.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rodrigo Wippel |
| Maintainers | rodrigowpl |
| Keywords | React, styled-components |

## Links

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

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.3.2
- [react-dom](https://npm.io/package/react-dom.md) ^16.3.2
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.1
- [styled-components](https://npm.io/package/styled-components.md) ^3.2.6

## 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.4 (latest) — 2018-05-06
- 1.0.3 — 2018-05-06
- 1.0.2 — 2018-05-06
- 1.0.1 — 2018-05-06
- 1.0.0 — 2018-05-06

## README

# react-progress

> Beautiful progress bar with React

You can see running example: https://rodrigowp.github.io/react-progress/

![](https://github.com/RodrigoWP/react-progress/blob/master/example.gif)

### Installation

### for npm users
```console
npm i --save @rodrigowpl/react-progress
```

### for yarn users
```console
yarn add @rodrigowpl/react-progress
```

## Simple usage

```jsx
import { Progress } from '@rodrigowpl/react-progress'

<Progress />
```

## Custom usage

```jsx
  <Progress
    backgroundColor='#fcdfdf'
    progressColor='#f9575b'
    height={10}
  />
```

### Props

| Property | Type | Default | Description |
|:---|:---|:---|:---|
| backgroundColor | string | transparent | Set background color to wrapper element
| progressColor | string | #6197c6 | Set progress bar background color
| height | number | 3 | Set progress bar height
| position | string | absolute | Set progress bar layout position
| fromTop | number | 0 | Set progress position from parent top

## Contributing

### Dependencies:

- Node.js `>=` v8;

### Up and running

- Install dependencies: `yarn` (or `npm i`);
- Run `yarn storybook` (or `npm run storybook`) to storybook on `http://localhost:6006`
- Run `yarn storybook:build` (or `npm run storybook:build`) for docs build (files will be) generated in the `docs` directory)
- Run `yarn build` (or `npm run build`) for production build (files will be generated in the `dist` directory)

### Scripts

- `yarn build (or npm run build)`: Build project to production
- `yarn storybook (or npm run storybook)`: Run Storybook on `6006` port
- `yarn storybook:build`: Build Storybook to static files
- `npm run pub`: Publish to npm

## License

[MIT](https://github.com/RodrigoWP/licenses/blob/master/LICENSE) &copy; Rodrigo Wippel

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