forked from airbnb/lottie
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Gabriel Peal
committed
Oct 26, 2020
1 parent
31b285d
commit 37f26cb
Showing
2 changed files
with
43 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| This repo is NOT for reporting issues on the individual libraries. | ||
| If you are looking for them, view the README for links to the individual libraries. | ||
|
|
||
| This repo is for the docs at https://airbnb.io/lottie. Proposing changes to the docs is ridiculously easy. Please follow the directions on the README. You don't even need to know git or use a terminal to update the docs. You can do it right from your browser. | ||
|
|
||
| Issues reported here are not checked regularly and will probably not get you very far. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,115 +1,37 @@ | ||
| # Lottie for [Android](https://github.com/airbnb/lottie-android), [iOS](https://github.com/airbnb/lottie-ios), [Web](https://github.com/airbnb/lottie-web), [React Native](https://github.com/airbnb/lottie-react-native), and [Windows](https://aka.ms/lottie) | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th> | ||
| <a href='https://play.google.com/store/apps/details?id=com.airbnb.lottie'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' height="80px"/></a> | ||
| </th> | ||
| <th> | ||
| <a href='https://www.microsoft.com/store/apps/9p7x9k692tmw?ocid=badge'><img src='https://assets.windowsphone.com/13484911-a6ab-4170-8b7e-795c1e8b4165/English_get_L_InvariantCulture_Default.png' alt='English badge' width='127px' height='52px'/></a> | ||
| </th> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| Lottie is a library for Android, iOS, Web, and Windows that parses [Adobe After Effects](http://www.adobe.com/products/aftereffects.html) animations exported as json with [Bodymovin](https://github.com/airbnb/lottie-web) and renders them natively on mobile and on the web! | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
| All of these animations were created in After Effects, exported with Bodymovin, and rendered natively with no additional engineering effort. | ||
|
|
||
| [Bodymovin](https://github.com/airbnb/lottie-web) is an After Effects plugin created by Hernan Torrisi that exports After effects files as json and includes a javascript web player. We've built on top of his great work to extend its usage to Android, iOS, React Native, and Windows. | ||
|
|
||
| Read more about it on our [blog post](http://airbnb.design/introducing-lottie/) | ||
| Or get in touch on GitHub or via [email protected] | ||
|
|
||
| ## Other Platforms | ||
| * [Xamarin (martijn00)](https://github.com/martijn00/LottieXamarin) | ||
| * [NativeScript (bradmartin)](https://github.com/bradmartin/nativescript-lottie) | ||
| * [Axway Appcelerator (m1ga)](https://github.com/m1ga/ti.animation) | ||
| * [ReactXP (colmbrady)](https://github.com/colmbrady/lottie-reactxp) | ||
| * [Flutter (simolus3)](https://github.com/simolus3/fluttie) | ||
| * [Flutter (fabiomsr)](https://github.com/fabiomsr/lottie-flutter) | ||
|
|
||
| ## Sample App | ||
|
|
||
| You can build the sample app for Android yourself or download it from the [Play Store](https://play.google.com/store/apps/details?id=com.airbnb.lottie). The sample app includes some built in animations but also allows you to load an animation from internal storage or from a url. | ||
|
|
||
| For Windows, you can get the [Lottie Viewer app](https://aka.ms/lottieviewer) to preview Lottie animation and codegen classes, and the [Lottie Samples app](https://aka.ms/lottiesamples) to get started with code samples and simple tutorials. | ||
|
|
||
| ## Shipping something with Lottie? | ||
|
|
||
| Email us at [[email protected]]([email protected]) and soon we will create a testimonals and use cases page with real world usages of Lottie from around the world. | ||
| We also have an internal regression testing repo that we can use to prevent causing regressions with your animations. | ||
|
|
||
| ## Alternatives | ||
| 1. Build animations by hand. Building animations by hand is a huge time commitment for design and engineering 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](https://github.com/facebookincubator/Keyframes). Keyframes is a wonderful new library from Facebook that they built for reactions. However, Keyframes doesn't support some of Lottie's features such as masks, mattes, trim paths, dash patterns, and more. | ||
| 2. 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. | ||
| 3. 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. | ||
| 4. Animated Vector Drawable (Android only). More performant because it runs on the RenderThread instead of the main thread. Supports only a subset of Lottie features. Progress can't be manually set. Doesn't support text or dynamic colors. Can't be loaded programatically or over the internet. | ||
|
|
||
| ## 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](https://www.youtube.com/watch?v=LvU55CUw5Ck&feature=youtu.be) | ||
|
|
||
| ## Contributing | ||
| Contributors are more than welcome. Just upload a PR with a description of your changes. | ||
|
|
||
| If you would like to add more JSON files feel free to do so! | ||
|
|
||
| ## Issues or feature requests? | ||
| 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. | ||
|
|
||
| ## Articles, Interviews & Podcasts | ||
|
|
||
| Here are some articles and podcasts from the Lottie team @ Airbnb | ||
|
|
||
| [Behind the scenes: Why we built Lottie, our new open-source animation tool here.](https://airbnb.design/introducing-lottie/) | ||
|
|
||
| [Dig into the details and back story with Brandon Withrow and Salih Abdul-Karim on the School of motion podcast](https://www.schoolofmotion.com/blog/after-effects-to-code-lottie-from-airbnb) | ||
|
|
||
| [Learn more about Lottie from Gabriel Peal on the Fragmented Podcast](http://fragmentedpodcast.com/episodes/82/) | ||
|
|
||
| [Lottie Animation with Brandon Withrow and Gabriel Peal on Software engineering daily podcast](https://softwareengineeringdaily.com/2017/08/10/lottie-animation-with-brandon-withrow-and-gabriel-peal/) | ||
|
|
||
|
|
||
| ## Community articles and videos | ||
|
|
||
| Heres some links from around the community | ||
|
|
||
| [A Lottie to Like](https://t.co/dadjvgv9vk) by Nick Butcher | ||
|
|
||
| [Creating better user experiences with animations and Lottie](https://pspdfkit.com/blog/2017/creating-better-user-experiences-with-animations-and-lottie/) by Samo Korosec and Stefan Keileithner | ||
|
|
||
| [How to use Lottie \(In Chinese\)](https://goo.gl/e7BkND) by PattyDraw | ||
|
|
||
| [A Beginning’s Guide to Lottie: Creating Amazing Animations in iOS Apps](https://www.appcoda.com/lottie-beginner-guide/#) by Simon NG | ||
|
|
||
| [Take your animations to the next level with Airbnb framework, Lottie](https://medium.com/@jamesrochabrun/take-your-animations-to-the-next-level-with-airbnb-framework-lottie-ab6c6152acba) by James Rochabrun | ||
|
|
||
| [iOS Swift Tutorial: Animations with After Effects and Lottie](https://www.youtube.com/watch?v=ESjFEaZx7UI) by Brian Advent | ||
|
|
||
| [iOS Swift Tutorial: Interactive Animations with After Effects and Lottie](https://www.youtube.com/watch?v=QyL-jp9bFdM) by Brian Advent | ||
|
|
||
| [After Effects for wiOS Developers: Dynamic Content in Animations](https://youtu.be/2HhgLir6Jz0?list=PLUDTy1CWIw-qu2EuzNVFQawyW5jmC5W7G) by Brian Advent | ||
|
|
||
| [Creating cool animations in android using Lottie](https://www.youtube.com/watch?v=T4v72xJqNpQ)[Chetan Sachdeva](https://www.youtube.com/channel/UC_4TBWZcI-tdZ02wESTRVNw) by Chetan Sachdeva | ||
|
|
||
| [Boost Your User Experience with Lottie for React Native](https://blog.reactnativecoach.com/boost-your-user-experience-with-lottie-for-react-native-5da1ac589982) by Samuli Hakoniemi | ||
|
|
||
| [How to use 'Lottie' in Framer X](https://www.youtube.com/watch?v=GflnbO5RMZI) by ruucm | ||
| # Lottie Documentation | ||
|
|
||
| This repo is the home of the unified Lottie docs hosted at [http://airbnb.io/lottie](http://airbnb.io/lottie). This repo is NOT the place to contribute to or report issues on any of the players or the After Effects plugin. | ||
|
|
||
| # Looking for the libraries? | ||
| ## Official Libraries | ||
| * [Android](https://github.com/airbnb/lottie-android/) | ||
| * [iOS](https://github.com/airbnb/lottie-ios/) | ||
| * [Web](https://github.com/airbnb/lottie-web/) | ||
| * [After Effects Plugin](https://github.com/airbnb/lottie-web/) | ||
|
|
||
| ## Unofficial Libraries | ||
| * [React Native](https://github.com/lottie-react-native/lottie-react-native) | ||
| * [Windows](https://github.com/windows-toolkit/Lottie-Windows) | ||
| * [Qt](https://blog.qt.io/blog/2019/03/08/announcing-qtlottie/) | ||
| * [Skia](https://skia.org/user/modules/skottie) | ||
| * [Xamarin](https://github.com/martijn00/LottieXamarin) | ||
| * [NativeScript](https://github.com/bradmartin/nativescript-lottie) | ||
| * [Axway Appcelerator](https://github.com/m1ga/ti.animation) | ||
| * [Qt QML](https://sea-region.github.com/kbroulik/lottie-qml) | ||
| * [Rlottie](https://github.com/Samsung/rlottie) | ||
| * [Python](https://gitlab.com/mattia.basaglia/python-lottie) | ||
|
|
||
|
|
||
| # Contributing to the docs directly on GitHub (easy) | ||
| Because the Lottie docs are created directly from the markdown in this repo, you can use the GitHub web editor to edit and propose changes to the docs directly from your browser without any knowledge of git. | ||
| To do that, find the markdown file with the docs you want to edit and follow [GitHub's instructions](https://docs.github.com/en/free-pro-team@latest/github/managing-files-in-a-repository/editing-files-in-another-users-repository) to edit and propose changes to a markdown file. Once approved, the docs will be updated immediately. | ||
|
|
||
| # Contributing to the docs by forking this repo (still pretty easy) | ||
| [http://airbnb.io/lottie](http://airbnb.io/lottie) runs on [docsify](https://docsify.js.org/#/?id=docsify). Docsify was chosen because it takes hosted markdown and generates the page dynamically. That means that simply updating the markdown files here is all that is needed to update [http://airbnb.io/lottie](http://airbnb.io/lottie). | ||
|
|
||
| 1. Fork and clone this repo. | ||
| 1. Install docsify: `sudo npm instal -g docsify-cli`. | ||
| 1. Startup the local docsify server with `docsify serve .` from the root of this repo. | ||
| 1. Edit the markdown and verify your changes on the localhost url outputted from the `docsify serve` command. | ||
| 1. Put up a pull request to this repo and tag `@gpeal` | ||
| 1. Enjoy the updated docs! |