Material Favorite Button

Additional

Language
Java
Version
0.1.5 (Sep 3, 2018)
Created
Oct 2, 2015
Updated
Sep 5, 2018
Owner
Ivan Baranov (IvBaranov)
Contributor
Ivan Baranov (IvBaranov)
1
Activity
Badge
Generate
Download
Source code
APK file

Blurb

Material Favorite Button

Material spinning favorite/star/like button.

Download

compile 'com.github.ivbaranov:materialfavoritebutton:0.1.5'

Usage

Declare in XML (see xml attributes below for customization):

<com.github.ivbaranov.mfb.MaterialFavoriteButton
    android:layout_width="wrap_content"
    android:layout_height="wrap_content" />

Or static initializer (see xml attributes below for customization):

MaterialFavoriteButton favorite = new MaterialFavoriteButton.Builder(this)
        .create();

Configure using xml attributes or setters in code:

app:mfb_state="false"                            // default button state
app:mfb_animate_favorite="true"                  // to animate favoriting
app:mfb_animate_unfavorite="false"               // to animate unfavoriting
app:mfb_padding="12"                             // image padding
app:mfb_favorite_image="@drawable/ic_fav"        // custom favorite resource
app:mfb_not_favorite_image="@drawable/ic_not_fav"// custom not favorite resource
app:mfb_rotation_duration="400"                  // rotation duration
app:mfb_rotation_angle="360"                     // rotation angle
app:mfb_bounce_duration="300"                    // bounce duration
app:mfb_color="black"                            // black or white default resources (enum)
app:mfb_type="star"                              // star or heart shapes (enum)
app:mfb_size="48"                                // button size

Make sure:

  • you are using either (mfb_favorite_image and mfb_not_favorite_image) or (mfb_color and mfb_type).
  • if you change mfb_size attribute you should also provide your own combination of mfb_favorite_image and mfb_favorite_image resources and mfb_padding attribute that will fit your new dimensions, otherwise you can get blurred icon

Set an OnFavoriteChangeListener to MaterialFavoriteButton:

favorite.setOnFavoriteChangeListener(
        new MaterialFavoriteButton.OnFavoriteChangeListener() {
          @Override
          public void onFavoriteChanged(MaterialFavoriteButton buttonView, boolean favorite) {
           //
          }
        });

Set an OnFavoriteAnimationEndListener to MaterialFavoriteButton:

favorite.setOnFavoriteAnimationEndListener(
        new MaterialFavoriteButton.OnFavoriteAnimationEndListener() {
          @Override
          public void onAnimationEnd(MaterialFavoriteButton buttonView, boolean favorite) {
            //
          }
        });
Usage in RecyclerView

To avoid triggering animation while re-rendering item view make sure you set favorite button state in onBindViewHolder without animation:

favoriteButton.setFavorite(isFavorite(data.get(position)));

Developed By

Ivan Baranov

License

Copyright 2015 Ivan Baranov

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.