Google Git
Sign in
android / platform / external / lottie / 860db6a9
commit860db6a990a02304468b35b0df3f46e21c093fa1[log] [tgz]
authorGabriel Peal <gpeal@users.noreply.github.com>Tue Dec 06 19:07:06 2016 -0800
committerGitHub <noreply@github.com>Tue Dec 06 19:07:06 2016 -0800
tree17cc47b4d4e6eef2b9091422349179c6581dc8c5
parentba48b8233d8ad3c6b427fa55d9150d25a67272a3 [diff]
Update README.md
1 file changed
tree: 17cc47b4d4e6eef2b9091422349179c6581dc8c5
  1. gifs/
  2. gradle/
  3. lottie/
  4. LottieSample/
  5. .gitignore
  6. build.gradle
  7. gradle.properties
  8. gradlew
  9. gradlew.bat
  10. LICENSE
  11. README.md
  12. settings.gradle
README.md

Lottie for Android (and iOS)

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 6,000

P2 P3

Lightbulb Business

AllSet Selfie

Abcs

Download

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'
}

Alternatives

  1. Build animations by hand. Building animations by hand is a huge time commitment for design and engingeering across Android and iOS. It's often hard or even impossible to justify spending so much time to get an animation right.
  2. Facebook Keyframes. Keyframes is a wonderful new library from Facebook that they built for reactions. However, it only supports a small subset of the features suppoted by Lottie such as masks, mattes, trim paths, dash patterns, and more.
  3. Gifs. Gifs are more than double the size of a bodymovin JSON and are rendered at a fixed size that can't be scaled up to match large and high density screens.
  4. Png sequences. Png sequences are even worse than gifs in that their file sizes are often 30-50x the size of the bodymovin json and also can't be scaled up.

Using Lottie

Lottie animations are rendered by LottieAnimationView. LottieAnimationView animations are defined by a LottieComposition. You can load a composition directly with LottieComposition.fromFile(...) which will look in src/main/assets or LottieComposition.fromJson(...) if you have a raw JSONObject (useful for loading animations from the newtork).

However, the simplest way to use it is with an xml attribute or to let LottieAnimationView load the composition:

<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:

LottieAnimationView animationView = findViewById(R.id.animation_view);
animationView.setAnimation("hello-world.json");
animationView.loop(true);
animationView.playAnimation();

Why is it called Lottie?

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

##Try it out Clone this repository and run the LottieSample module to see a bunch of sample animations. The JSON files for them are located in /assets.

Contributing

Contributers 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.

If you would like to add more JSON files and screenshot tests, feel free to do so and add the test to LottieTest.