Skip to content

Commit 6f45366

Browse files
authored
Update README.md
1 parent 3f99ffa commit 6f45366

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,82 @@
11
# progress-image-view-android
22
Simple progress with ImageView android
3+
4+
## Demo
5+
<p align="center">
6+
<img src="etc/demo.gif" alt="progress image view" />
7+
</p>
8+
9+
## Install
10+
Add the dependecy
11+
12+
TODO
13+
14+
15+
### Add permissions in your androidmanifest.xml
16+
```xml
17+
<uses-permission android:name="android.permission.INTERNET" />
18+
```
19+
20+
## Usage
21+
22+
```xml
23+
<safety.com.br.progressimageview.ProgressImageView
24+
android:layout_width="120dp"
25+
android:layout_height="120dp"
26+
android:id="@+id/progress_image_view" />
27+
28+
```
29+
30+
```java
31+
32+
private ProgressImageView progressImageView;
33+
34+
progressImageView = (ProgressImageView) findViewById(R.id.progress_image_view);
35+
36+
//Start animation of loading
37+
progressImageView.showLoading();
38+
39+
```
40+
By default the animation of progress is auto hide.
41+
if you to prefer, you can set auto hide `false`
42+
```java
43+
progressImageView.showLoading().withAutoHide(false);
44+
```
45+
but for stop the animation you should invoke method `hideLoading`
46+
```java
47+
progressImageView.hideLoading();
48+
```
49+
50+
You can set the color of animation and set the size of border of animation
51+
```java
52+
progressImageView.withBorderColor(Color.RED).withBorderSize(10);
53+
```
54+
and set custom offSet
55+
```java
56+
progressImageView.withOffset(10);
57+
```
58+
### Acknowledgment
59+
60+
* [Leandro Ferreira](https://github.com/leandroBorgesFerreira)
61+
62+
63+
## License
64+
The MIT License (MIT)
65+
66+
Copyright (c) Safety System Technology
67+
68+
Permission is hereby granted, free of charge, to any person obtaining a
69+
copy of this software and associated documentation files (the "Software"),
70+
to deal in the Software without restriction, including without limitation
71+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
72+
and/or sell copies of the Software, and to permit persons to whom the Software is
73+
furnished to do so, subject to the following conditions:
74+
75+
The above copyright notice and this permission notice shall be included
76+
in all copies or substantial portions of the Software.
77+
78+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
79+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
80+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
81+
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
82+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)