Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wnafee/vector-compat
A support library for VectorDrawable and AnimatedVectorDrawable classes introduced in Lollipop
https://github.com/wnafee/vector-compat
Last synced: about 2 months ago
JSON representation
A support library for VectorDrawable and AnimatedVectorDrawable classes introduced in Lollipop
- Host: GitHub
- URL: https://github.com/wnafee/vector-compat
- Owner: wnafee
- Created: 2015-04-08T14:26:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-24T02:42:14.000Z (almost 8 years ago)
- Last Synced: 2024-02-14T20:34:48.270Z (7 months ago)
- Language: Java
- Homepage:
- Size: 588 KB
- Stars: 1,228
- Watchers: 44
- Forks: 161
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vector-compat
A support library for [`VectorDrawable`][1] and [`AnimatedVectorDrawable`][2] introduced in Lollipop with fully backwards compatible tint support (api 14+ so far)
`vector-compat` provides the necessary tools to make animated icons similar to the new drawer hamburger icon that morphs to a back arrow when clicked. Any other morph animation between icons can be defined _purely in `xml` (**no java code required**)_ and the library takes care of the transformation animation. Because they are in vector format, these drawables can be of any height and width with no resulting pixelation.
The library will transparently fall back to the lollipop implementation of `VectorDrawable` and `AnimatedVectorDrawable` on api 21+ devices
##Commonly used animations
The library packs some ready-made morph animations developers can use in their code with `MorphButton`. More will be added soon as this is a work-in-progress. The library has the following morph animations :
* Play-Pause morph animation (bi-directional morph)
* Play-Stop morph animation (bi-directional morph)
* Arrow-Hamburger menu morph animation (bi-directional morph)
**The goal is to, with time, create a repo of commonly used morph animations that lots of developers find useful.**
If you have requests for particular morph animations, please open a [new issue](https://github.com/wnafee/vector-compat/issues/new) and I'll work on adding them to the library. You are also welcome to create a [pull request](https://github.com/wnafee/vector-compat/compare) if you've created some of your own. **_Please contribute_** :)
## Download
Add the `vector-compat` dependency to your `build.gradle` file and make sure to use `buildToolsVersion` 22 or higher:
[](http://search.maven.org/#search%7Cga%7C1%7Cvector-compat)
```groovy
android {
// use version 22 or higher
buildToolsVersion "22.0.1"
...
}
dependencies {
compile 'com.wnafee:vector-compat:1.0.5'
...
}
```
## Proguard
If you're using proguard for code shrinking and obfuscation, make sure to add the following:
```proguard
-keep class com.wnafee.vector.** { *; }
```
## Usage
`VectorDrawable` and `AnimatedVectorDrawable` xml drawable syntax is exactly the same as the lollipop documentation (can be seen [here][1] and [here][2] respectively). With 2 caveats:
* Some attributes under the `` nodes must be listed once for the `android:` namespace and once for the local namespace with a `vc_` prefix (e.g. `app:vc_fillColor`). See example [here][4]. (For a complete list of `vc_` prefixed attributes see [attr.xml][6] for )
* Any `pathType` anim xml must have the `android:valueType="pathType"` in addition to `app:vc_valueType="pathType"` to allow for lollipop implementation fallback. See example [here][5].
#### Inflation
`VectorDrawable` and `AnimatedVectorDrawable` in this support library can be inflated in one of 2 ways:
* Calling static `getDrawable()` methods:
```java
//This will only inflate a drawable with as the root element
VectorDrawable.getDrawable(context, R.drawable.ic_arrow_vector);
//This will only inflate a drawable with as the root element
AnimatedVectorDrawable.getDrawable(context, R.drawable.ic_arrow_to_menu_animated_vector);
// This will inflate any drawable and will auto-fallback to the lollipop implementation on api 21+ devices
ResourcesCompat.getDrawable(context, R.drawable.any_drawable);
````
_If inflating the Drawable in java code, it is recommended to always use `ResourcesCompat.getDrawable()` as this handles Lollipop fallback when applicable. This allows the system to cache Drawable ConstantState and hence is more efficient_
* directly from the `MorphButton` view in xml:
```xml
```
#### MorphButton
`MorphButton` is a `CompoundButton` with 2 states: `MorphState.START` or `MorphState.END`. The attributes `vc_startDrawable` and `vc_endDrawable` define which foreground drawables to use for the button depending on the button's state. These can be any type of drawable (e.g. `BitmapDrawable`, `ColorDrawable`, `VectorDrawable`, `AnimatedVectorDrawable` etc.)
To use MorphButton in your app, make sure to include the `morphButtonStyle` item in your base app theme:
```xml
<item name="morphButtonStyle">@style/Widget.MorphButton</item>
```
`MorphButtons` allow you to tint your foreground drawables (i.e. `vc_startDrawable` and `vc_endDrawable`) and background drawable separately in both xml and java. See the following examples for defining `MorphButtons`:
**XML**:
```xml
```
**Java**:
```java
MorphButton mb = new MorphButton(this);
mb.setBackgroundTintList(getResources().getColorStateList(R.color.background_tint_color));
mb.setForegroundTintList(ColorStateList.valueOf(Color.RED));
mb.setStartDrawable(R.drawable.ic_pause_to_play);
mb.setEndDrawable(R.drawable.ic_play_to_pause);
mb.setState(MorphState.END);
```
The `scaleType` attribute defines how to scale the foreground drawable to fill the button's background. This is the same as [`ImageView.ScaleType`][7] which you can take a look at [here][7].
Button clicks will toggle between the foreground drawables. If the drawables happen to implement the [`Animatable`][3] interface (e.g. `AnimatedVectorDrawable` or `AnimationDrawable`) then `start()` will be automatically called to animate between the start and end drawables defined in xml.
MorphButton states can be set manually via `setState()` methods:
```java
// transition with no animation
myMorphButton.setState(MorphState.END)
// ... or transition with animation if drawable is Animatable
myMorphButton.setState(MorphState.START, true)
````
If you need to be informed of button state changes you need to add an `OnStateChangedListener`:
```java
MyMorphButton.setOnStateChangedListener(new OnStateChangedListener() {
@Override
public void onStateChanged(MorphState changedTo, boolean isAnimating) {
// changeTo is the new state
// isAnimating = true if the state changed with animation
// Do something here
}
});
```
## License
Copyright 2015 Wael Nafee
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]: http://developer.android.com/reference/android/graphics/drawable/VectorDrawable.html
[2]: http://developer.android.com/reference/android/graphics/drawable/AnimatedVectorDrawable.html
[3]: http://developer.android.com/reference/android/graphics/drawable/Animatable.html
[4]: https://github.com/wnafee/vector-compat/blob/master/library/src/main/res/drawable/ic_arrow_vector.xml
[5]: https://github.com/wnafee/vector-compat/blob/master/library/src/main/res/anim/arrow_to_drawer_path.xml
[6]: https://github.com/wnafee/vector-compat/blob/master/library/src/main/res/values/attr.xml
[7]: http://developer.android.com/reference/android/widget/ImageView.ScaleType.html