Skip to content

Commit 6f0397f

Browse files
fixed some issues
2 parents fb7fd71 + 1386c29 commit 6f0397f

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

README.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,36 @@
1-
# ProgressX
1+
# ProgressX ![API](https://img.shields.io/badge/API-15%2B-brightgreen.svg?style=flat) [![Known Vulnerabilities](https://snyk.io/test/github/TutorialsAndroid/progressx/badge.svg?targetFile=library%2Fbuild.gradle)](https://snyk.io/test/github/TutorialsAndroid/progressx?targetFile=library%2Fbuild.gradle)
22

33
A material style progress wheel that you can integrate into your app
44

5+
**Library available at JitPack.io**
6+
7+
[![](https://jitpack.io/v/TutorialsAndroid/progressx.svg)](https://jitpack.io/#TutorialsAndroid/progressx)
8+
9+
## Important
10+
11+
**Note this library was made in the making for `Kinda` app this library was copied from `materialish-progress` repository on github we made this library because we want to use own library on `Kinda` app.So this library is in development we will monthly
12+
update this library with some changes.**
13+
14+
**Sample Screen**
15+
16+
![](https://github.com/TutorialsAndroid/progressx/blob/master/art/device-2019-03-23-154713.png)
17+
518
## Download
619

20+
Add it in your root build.gradle at the end of repositories:
721

22+
allprojects {
23+
repositories {
24+
...
25+
maven { url 'https://jitpack.io' }
26+
}
27+
}
28+
29+
Step 2. Add the dependency
30+
31+
dependencies {
32+
implementation 'com.github.TutorialsAndroid:progressx:v1.0'
33+
}
834

935
## Usage
1036

@@ -72,14 +98,28 @@ This way, the wheel will be as big as the parent layout. Be warned though, if th
7298

7399
In the xml definition, besides the ```fillRadius``` property, you can set:
74100

75-
* matProg_progressIndeterminate: boolean, if you want the wheel to spin right away.
76-
* matProg_barColor: color, sets the small bar's color (the spinning bar in the indeterminate wheel, or the progress bar)
77-
* matProg_barWidth: dimension, the width of the spinning bar
78-
* matProg_rimColor: color, the wheel's border color
79-
* matProg_rimWidth: dimension, the wheel's width (not the bar)
80-
* matProg_spinSpeed: float, the base speed for the bar in indeterminate mode, and the animation speed when setting a value on progress. The speed is in full turns per second, this means that if you set speed as 1.0, means that the bar will take one second to do a full turn.
81-
* matProg_barSpinCycleTime: integer, the time in milliseconds the indeterminate progress animation takes to complete (extending and shrinking the bar while spinning)
82-
* matProg_circleRadius: dimension, the radius of the progress wheel, it will be ignored if you set fillRadius to true
83-
* matProg_fillRadius: boolean, set to true if you want the progress wheel to fill the whole layout
84-
* matProg_linearProgress: boolean, set to true if you want a linear animation on the determinate progress (instead of the interpolated default one).
101+
* `matProg_progressIndeterminate: boolean`, if you want the wheel to spin right away.
102+
* `matProg_barColor: color`, sets the small bar's color (the spinning bar in the indeterminate wheel, or the progress bar)
103+
* `matProg_barWidth: dimension`, the width of the spinning bar
104+
* `matProg_rimColor: color`, the wheel's border color
105+
* `matProg_rimWidth: dimension`, the wheel's width (not the bar)
106+
* `matProg_spinSpeed: float`, the base speed for the bar in indeterminate mode, and the animation speed when setting a value on progress. The speed is in full turns per second, this means that if you set speed as 1.0, means that the bar will take one second to do a full turn.
107+
* `matProg_barSpinCycleTime: integer`, the time in milliseconds the indeterminate progress animation takes to complete (extending and shrinking the bar while spinning)
108+
* `matProg_circleRadius: dimension`, the radius of the progress wheel, it will be ignored if you set fillRadius to true
109+
* `matProg_fillRadius: boolean`, set to true if you want the progress wheel to fill the whole layout
110+
* `matProg_linearProgress: boolean`, set to true if you want a linear animation on the determinate progress (instead of the interpolated default one).
111+
112+
```
113+
Copyright 2019 ProgressX
114+
115+
Licensed under the Apache License, Version 2.0 (the "License");
116+
you may not use this file except in compliance with the License.
117+
You may obtain a copy of the License at
118+
119+
http://www.apache.org/licenses/LICENSE-2.0
85120
121+
Unless required by applicable law or agreed to in writing, software
122+
distributed under the License is distributed on an "AS IS" BASIS,
123+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
124+
See the License for the specific language governing permissions and
125+
limitations under the License.

0 commit comments

Comments
 (0)