lottie-android README

The project's README from github.com/airbnb/lottie-android. As one markdown file: README.md.

Lottie for Android, iOS, React Native, Web, and Windows

Build Status

Get it on Google Play

Lottie is a mobile library for Android 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 engineer painstakingly recreating it by hand. They say a picture is worth 1,000 words so here are 13,000:

Sponsors

Lottie is maintained and improved on nights and weekends. If you use Lottie in your app, please consider sponsoring it to help ensure that we can continue to improve the project we love. Click the sponsor button above to learn more

Sponsor Button

Lead Sponsors

Lottiefiles

Lottie Lab

Airbnb

Stream

Emerge Tools

Coinbase

View documentation, FAQ, help, examples, and more at airbnb.io/lottie

Example1

Example2

Example3

Community

Example4

Download

Gradle is the only supported build configuration, so just add the dependency to your project build.gradle file:

dependencies {
  implementation 'com.airbnb.android:lottie:$lottieVersion'
}

The latest Lottie version is: lottieVersion

The latest stable Lottie-Compose version is: lottieVersion Click here for more information on Lottie-Compose.

Lottie 2.8.0 and above only supports projects that have been migrated to androidx. For more information, read Google's migration guide.

Contributing

Because development has started for Lottie Compose, Gradle, and the Android Gradle Plugin will be kept up to date with the latest canaries. This also requires you to use Android Studio Canary builds. Preview builds can be installed side by side with stable versions.

lottie-android (airbnb/lottie-android)

Searching Database…

What is this?Lottie is a mobile library that parses Adobe After Effects animations exported as JSON via the Bodymovin plugin and renders them natively on Android, iOS, Web, and React Native.
Is it a UI framework or just an animation renderer?It's a rendering library you drop into an app to play vector animations natively; it's not a full UI framework, just the animation engine (with a dedicated Lottie-Compose wrapper for Jetpack Compose).
How do I add it to an Android project?Add the Lottie dependency to your module's build.gradle file; Gradle is the only supported build configuration.
Do I need to migrate to AndroidX first?Yes, Lottie 2.8.0 and above only supports projects that have been migrated to AndroidX.
Does it work with the stable Android Gradle Plugin, or do I need canary builds?For contributing to the project itself you need Android Studio Canary builds since AGP tracking follows the latest canaries, but using the library in your own app just needs standard Gradle.
Who creates the animations — designers or engineers?Designers create and export the animations from After Effects themselves using Bodymovin, so engineers no longer have to hand-recreate the motion in code.
Which platforms does the Lottie ecosystem cover?Beyond this Android repo, Lottie has sibling implementations for iOS, Web, React Native, and Windows, all sharing the same JSON animation format.
Where can I find docs and examples?Full documentation, FAQ, help, and examples are hosted at airbnb.io/lottie.
Can I use Lottie with Jetpack Compose?Yes, there's a separate Lottie-Compose artifact with its own versioning for use in Compose-based apps.
Is the project actively maintained?The README notes it's maintained on nights and weekends by contributors and asks users to consider sponsoring to help keep improvements going.
Creator
airbnb
Size
134.2 MB
Stars
35.8K
Age
10y
Commits · 90 Days