react-yan-progress
This is a cascading progress bar component based on react
Installation
$ npm install react-yan-progress
Qucik start
;;; { return <div className="App"> <YanProgress total=100 done=60 modify=30 /> </div> ;} const rootElement = document;ReactDOM;
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
$ yarn run test
Dev
link react-yan-progress
$ yarn link
test test-demo
$ yarn link react-yan-progress
unlink react-yan-progress
$ 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 v0.3.0