Material Ripple Layout

Ripple effect wrapper for Android Views

Including in your project

Add Sonatype Maven repository and import dependencies

repositories {
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots/"
    }
}

compile 'com.balysv:material-ripple:0.9.3-SNAPSHOT@aar'

See https://github.com/balysv/material-ripple/issues for upcoming features and requests.

Usage

Use static initializer on your View (see xml attributes below for customization)

MaterialRippleLayout.on(view)
           .rippleColor(Color.BLACK)
           .create();

Or wrap your View with MaterialRippleLayout in your layout file:

<com.balysv.materialripple.MaterialRippleLayout
    android:id="@+id/ripple"
    android:layout_width="match_parent"
    android:layout_height="wrap_content">

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_gravity="center"
        android:text="Button inside a ripple"/>

</com.balysv.materialripple.MaterialRippleLayout>

If using in an AdapterView you must set rippleInAdapter to true

Configure using xml attributes or appropriate setters in code:

app:rippleOverlay="true"              // if true, ripple is drawn in foreground; false - background
app:rippleColor="#ff0000"             // color of ripple
app:rippleAlpha="0.1"                 // alpha of ripple
app:rippleDimension="10dp"            // radius of hover and starting ripple
app:rippleHover="true"                // if true, a hover effect is drawn when view is touched
app:rippleInAdapter="true"            // if true, MaterialRippleLayout will optimize for use in AdapterViews
app:rippleDuration="350"              // duration of ripple animation
app:rippleFadeDuration="75"           // duration of fade out effect on ripple
app:rippleDelayClick="true"           // if true, delays calls to OnClickListeners until ripple effect ends
app:rippleBackground="#FFFFFF"        // background under ripple drawable; used with rippleOverlay="false"
app:ripplePersistent="true"           // if true, ripple background color persists after animation, until setRadius(0) is called

Set an OnClickListener to MaterialRippleLayout:

findViewById(R.id.ripple).setOnClickListener(new View.OnClickListener() {
    @Override public void onClick(View v) {
        // handle me 
    }
});

Or if using in an AdapterView, simply use OnItemClickListener

Access your child View if necessary:

MyCustomView view = MaterialRippleLayout.getChildView();

Support for Android api versions < 14

For those unlucky developers that need to support older versions than 14, there's a way to do it.

You can use this library in addition with Jake Wharton's animation backport (http://nineoldandroids.com/) changing the imports from import android.animation.*; to: import com.nineoldandroids.animation.*; , import android.util.Property; to import com.nineoldandroids.util.Property; and in MaterialRippleLayout.java file, calling function shouldDelayChildPressedState() only if you're using api greater than 14.

Developed By

Balys Valentukevicius

License

Copyright 2014 Balys Valentukevicius

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.