Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IvBaranov/MaterialFavoriteButton
Animated favorite/star/like button
https://github.com/IvBaranov/MaterialFavoriteButton
android-ui animation button favorite material material-design material-ui
Last synced: 29 days ago
JSON representation
Animated favorite/star/like button
- Host: GitHub
- URL: https://github.com/IvBaranov/MaterialFavoriteButton
- Owner: IvBaranov
- License: apache-2.0
- Created: 2015-10-02T13:29:14.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-05T14:04:15.000Z (over 6 years ago)
- Last Synced: 2024-08-09T13:15:59.234Z (5 months ago)
- Topics: android-ui, animation, button, favorite, material, material-design, material-ui
- Language: Java
- Homepage:
- Size: 759 KB
- Stars: 589
- Watchers: 19
- Forks: 92
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Material Favorite Button
========================
Material spinning favorite/star/like button.
[](http://android-arsenal.com/details/1/2612) [](https://travis-ci.org/IvBaranov/MaterialFavoriteButton)
![Demo Image][1]
Download
--------
```groovy
compile 'com.github.ivbaranov:materialfavoritebutton:0.1.5'
```
Usage
-----
Declare in XML (see xml attributes below for customization):
```xml
```
Or static initializer (see xml attributes below for customization):
```java
MaterialFavoriteButton favorite = new MaterialFavoriteButton.Builder(this)
.create();
```
Configure using xml attributes or setters in code:
```java
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`:
```java
favorite.setOnFavoriteChangeListener(
new MaterialFavoriteButton.OnFavoriteChangeListener() {
@Override
public void onFavoriteChanged(MaterialFavoriteButton buttonView, boolean favorite) {
//
}
});
```
Set an `OnFavoriteAnimationEndListener` to `MaterialFavoriteButton`:
```java
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:
```java
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.
```
[1]: https://cloud.githubusercontent.com/assets/6000572/10363036/ad97cfae-6dba-11e5-980a-1f5d82afd773.gif