Skip to content

Commit

Permalink
Merge pull request traex#61 from traex/fix/README
Browse files Browse the repository at this point in the history
Fix/readme
  • Loading branch information
traex committed May 13, 2015
2 parents 9b04c21 + 2c0ab45 commit 3f40244
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The lib is available on Maven Central, you can find it with [Gradle, please](htt
``` xml

dependencies {
compile 'com.github.traex.rippleeffect:library:1.2.4'
compile 'com.github.traex.rippleeffect:library:1.3'
}

```
Expand Down Expand Up @@ -44,6 +44,18 @@ Declare a RippleView inside your XML layout file with a content like an ImageVie
</com.andexert.library.RippleView>
```

If you want to know when the Ripple effect is finished, you can set a listener on your view
```
rippleView.setOnRippleCompleteListener(new RippleView.OnRippleCompleteListener() {
@Override
public void onComplete(RippleView rippleView) {
Log.d("Sample", "Ripple completed");
}
});
```

### Customization

You can change several attributes in the XML file, you have to remove "rv_" if you are using a version below v1.1.1 :
Expand All @@ -59,6 +71,8 @@ You can change several attributes in the XML file, you have to remove "rv_" if y
* app:rv_zoomDuration [integer def:150] --> Duration of zoom animation
* app:rv_zoomScale [float def:1.03] --> Scale of zoom animation

For each attribute you can use getters and setters to change values dynamically.

### Troubleshooting

If you want to use the double ripple you have to set a background for the RippleView or for its child.
Expand Down
6 changes: 3 additions & 3 deletions sample/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ android {

dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile project(':library')
compile 'com.android.support:appcompat-v7:22.1.1'
compile 'com.github.traex.rippleeffect:library:1.3'
compile 'com.android.support:appcompat-v7:22.0.0'
compile 'com.android.support:palette-v7:22.0.0'
compile 'com.android.support:recyclerview-v7:22.0.0'
compile 'com.android.support:support-v4:22.1.1'
compile 'com.android.support:support-v4:22.0.0'
compile 'com.squareup.picasso:picasso:2.5.1'
}

0 comments on commit 3f40244

Please sign in to comment.