Skip to content

Commit 2661f3e

Browse files
author
Minh Tran
committed
Update README.md
1 parent f5b01db commit 2661f3e

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
11
# React Progress Bar Plus
2+
3+
Progress bar component for ReactJS.
4+
5+
[<img src="./screen-shot.png" width="100%"/>](http://vn38minhtran.github.io/react-progress-bar-plus)
6+
7+
## Installation
8+
9+
```bash
10+
npm install --save react-progress-bar-plus
11+
```
12+
13+
## Usage
14+
15+
### JS
16+
17+
```js
18+
var ProgressBar = require('react-progress-bar-plus');
19+
20+
var percent = 0;
21+
22+
<ProgressBar percent={10}/>
23+
```
24+
25+
### CSS
26+
27+
**Webpack:**
28+
29+
```js
30+
require('react-progress-bar-plus/lib/progress-bar.css');
31+
```
32+
33+
**Without Webpack:**
34+
35+
```html
36+
<link rel="stylesheet" type="text/css" href="path/to/react-progress-bar-plus/lib/progress-bar.css">
37+
```
38+
39+
## Props
40+
| Name | Type | Default | Description |
41+
|------|------|---------|-------------|
42+
| percent | number | -1 | Progress percent |
43+
| onTop | bool | false | Progrees bar will ontop & height 100% |
44+
| autoIncrement | bool | false | if `true` percent will auto increment `Math.random() + 1 - Math.random()`% in `intervalTime` ms. |
45+
| intervalTime | number | 200 | Interval time for auto increment. |
46+
47+
## Example
48+
49+
View [demo](http://vn38minhtran.github.io/react-progress-bar-plus) or example folder.

screen-shot.png

6.09 KB
Loading

0 commit comments

Comments
 (0)