commit | eed0ec09b9a4ddf17ffeda2fe85f7d7ce7914a67 | [log] [tgz] |
---|---|---|
author | Gabriel Peal <gabriel.peal@airbnb.com> | Wed Jan 25 13:45:06 2017 -0800 |
committer | Gabriel Peal <gabriel.peal@airbnb.com> | Wed Jan 25 13:45:06 2017 -0800 |
tree | e1aa8a8a88172af7db47cf2225a7f53a49c9af7a | |
parent | 770a916b26c2bf82442dbd81ffe2caa9571b9da0 [diff] |
Revert build to 0.9.16
Lottie is a mobile library for Andorid and iOS that parses Adobe After Effects animations exported as json with bodymovin and renders them natively on mobile!
For the first time, designers can create and ship beautiful animations without an enginineer painstakingly recreating it be hand.
They say a picture is worth 1,000 words so here are 7,000
Gradle is the only supported build configuration, so just add the dependency to your project build.gradle
file:
dependencies { compile 'com.airbnb.android:lottie-android:1.0.0' }
Lottie supports Jellybean (API 16) and above. The simplest way to use it is with LottieAnimationView:
<com.airbnb.lottie.LottieAnimationView android:id="@+id/animation_view" android:layout_width="wrap_content" android:layout_height="wrap_content" app:lottie_fileName="hello-world.json" app:lottie_loop="true"/>
Or you can load it programatically in multiple ways. From a json asset in res/assets:
LottieAnimationView animationView = findViewById(R.id.animation_view); animationView.setAnimation("hello-world.json"); animationView.loop(true);
This method will load the file and parse the animation in the background and asynchronously start rendering once completed.
If you want to reuse an animation such as in each item of a list or load it from a network request JSONObject:
LottieAnimationView animationView = findViewById(R.id.animation_view); ... LottieComposition composition = LottieComposition.fromJson(getResources(), jsonObject, (composition) -> { animationView.setComposition(composition); animationView.playAnimation();```` });
You can then control the animation or add listeners:L
animationView.addAnimatorUpdateListener((animation) -> { // Do something. }); animationView.playAnimation(); ... if (animationView.isAnimating()) { // Do something. } ... animationView.setProgress(0.5f); ... // Custom animation speed or duration. ValueAnimator animator = ValueAnimator.ofFloat(0f, 1f) .setDuration(500); animator.addUpdateListener(animation -> { animationView.setProgress(animation.getAnimatedValue()); }); animator.start(); ... animationView.cancelAnimation();
Under the hood, LottieAnimationView
uses LottieDrawable
to render its animations. If you need to, you can use the the drawable form directly:
LottieDrawable drawable = new LottieDrawable(); LottieComposition.fromAssetFileName(getContext(), "hello-world.json", (composition) -> { drawable.setComposition(composition); });
If your animation will be frequently reused, LottieAnimationView
has an optional caching strategy built in. Use LottieAnimationView#setAnimation(String, CacheStrategy)
. CacheStrategy
can be Strong
, Weak
, or None
to have LottieAnimationView
hold a strong or weak reference to the loaded and parsed animation.
Clone this repository and run the LottieSample module to see a bunch of sample animations. The JSON files for them are located in /assets.
The sample app can also load json files at a given url or locally on your device (like Downloads or on your sdcard).
Lottie is named after a German film director and the foremost pioneer of silhouette animation. Her best known films are The Adventures of Prince Achmed (1926) – the oldest surviving feature-length animated film, preceding Walt Disney's feature-length Snow White and the Seven Dwarfs (1937) by over ten years The art of Lotte Reineger
Contributors are more than welcome. Just upload a PR with a description of your changes. Lottie uses Facebook screenshot tests for Android to identify pixel level changes/breakages. Please run ./gradlew --daemon recordMode screenshotTests
before uploading a PR to ensure that nothing has broken. Use a Nexus 5 emulator running Lollipop for this. Changed screenshots will show up in your git diff if you have.
If you would like to add more JSON files and screenshot tests, feel free to do so and add the test to LottieTest
.
File github issues for anything that is unexpectedly broken. If an After Effects file is not working, please attach it to your issue. Debugging without the original file is much more difficult.