# react-yan-progress

> This is a cascading progress bar component based on react

Latest version **0.2.0** (published 2019-01-04) · 0 weekly downloads

## Install

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

## 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.2.0 |
| Published | 2019-01-04 |
| First published | 2018-11-16 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 272.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | yangfan2016 |
| Keywords | react, react-component, progress-bar |

## Links

- npm: https://www.npmjs.com/package/react-yan-progress
- npm.io page: https://npm.io/package/react-yan-progress

## 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.2.0 (latest) — 2019-01-04
- 0.1.4 — 2018-12-31
- 0.1.3 — 2018-11-17
- 0.1.2 — 2018-11-17
- 0.1.1 — 2018-11-16
- 0.1.0 — 2018-11-16

## README

## react-yan-progress 
[![NPM version](https://img.shields.io/npm/v/react-yan-progress.svg?style=flat)](https://www.npmjs.com/package/react-yan-progress) 
[![Build Status](https://travis-ci.org/Yangfan2016/react-yan-progress.svg?branch=master)](https://travis-ci.org/Yangfan2016/react-yan-progress)
[![Coverage Status](https://coveralls.io/repos/github/Yangfan2016/react-yan-progress/badge.svg?branch=master)](https://coveralls.io/github/Yangfan2016/react-yan-progress?branch=master)


This is a cascading progress bar component based on react
![yan-progress](https://raw.githubusercontent.com/Yangfan2016/PicBed/master/Blog/yan-progress.gif)

### Installation
```bash
$ npm install react-yan-progress
```
### Qucik start
```js
import React from "react";
import ReactDOM from "react-dom";
import YanProgress from 'react-yan-progress';

function App() {
  return (
    <div className="App">
      <YanProgress total={100} done={60} modify={30} />
    </div>
  );
}

const rootElement = document.getElementById("root");
ReactDOM.render(<App />, rootElement);
```

### API

| params | description | type | default |
| :----: | :----: | :----: | :----: |
| total | The total of progress | number | — | 
| done | The number of done | number | — |
| modify | The number of modified base on done | number | — |
| tip | Custom Style (Array contains 3 items, in turn: uncomplete, done, and modified, each item configuration as shown in iTipConfig below)|iTipConfig|—|

iTipConfig

| params | description | type | memo |
| :----: | :----: | :----: | :----: | 
| text | The tooltip text ('X'is a placeholder) | string | The color type same with CSS |
| fillStyle | The background color of progress bar | string | The color type same with CSS |

### Test

```bash
$ yarn run test
```
### Dev

link react-yan-progress
```bash
$ yarn link
```

test test-demo
```bash
$ yarn link react-yan-progress
```

unlink react-yan-progress
```bash
$ yarn unlink
```

### Contributing
- Fork this Repo first
- Clone your Repo
- Install dependencies by `$ npm install`
- Checkout a feature branch
- Feel free to add your features
- Make sure your features are fully tested
- Publish your local branch, Open a pull request
- Enjoy hacking <3

---
built upon love by [docor](https://github.com/turingou/docor.git) v0.3.0

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