Skip to content

Commit 4989ebc

Browse files
committed
Doc
1 parent 4cec729 commit 4989ebc

File tree

2 files changed

+42
-2
lines changed

2 files changed

+42
-2
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,42 @@ var Circles = require('react-native-android-circles');
9898
/>
9999

100100
```
101+
102+
## Available props & methods
103+
104+
### Props
105+
106+
```
107+
barColors: PropTypes.array,
108+
barWidth: PropTypes.number,
109+
blockCount: PropTypes.number,
110+
blockScale: PropTypes.number,
111+
contourColor: PropTypes.string,
112+
textColor: PropTypes.string,
113+
contourSize: PropTypes.number,
114+
delayMillis: PropTypes.number,
115+
fillColor: PropTypes.string,
116+
value: PropTypes.number,
117+
maxValue: PropTypes.number,
118+
rimColor: PropTypes.string,
119+
rimWidth: PropTypes.number,
120+
spinSpeed: PropTypes.number,
121+
startAngle: PropTypes.number,
122+
textScale: PropTypes.number,
123+
textSize: PropTypes.number,
124+
unit: PropTypes.string,
125+
unitVisible: PropTypes.bool,
126+
unitColor: PropTypes.string,
127+
unitScale: PropTypes.number,
128+
unitSize: PropTypes.number,
129+
animated: PropTypes.bool,
130+
text: PropTypes.string,
131+
textMode: PropTypes.oneOf(['text', 'value', 'percent']),
132+
```
133+
134+
### Methods
135+
136+
```
137+
.spin()
138+
.stopSpinning()
139+
```

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@
1212
},
1313
"license": "MIT",
1414
"peerDependencies": {
15-
"react-native": ">= 0.15.0"
15+
"react-native": ">= 0.16.0"
1616
},
1717
"keywords": [
1818
"react-component",
1919
"react-native",
20-
"android"
20+
"android",
21+
"progress bar"
2122
]
2223
}

0 commit comments

Comments
 (0)