Releases: airbnb/lottie-android
5.2.0
Compose Breaking Change
LottieAnimation now takes progress as a () -> Float rather than a Float. This allows Lottie to redraw without triggering a recomposition every time progress updates. For more information, refer to the Compose phase docs. The existing API will exist as deprecated for one more release but will then be removed. For the vast majority of use cases:
LottieAnimation(composition, progress)will become:
LottieAnimation(composition, { progress })or
LottieAnimation(
composition = composition,
progress = { progress }
)Bugs Fixed
- De-dupe gradient stops. On pre-Oreo devices, if you had color and opacity stops in the same place and used hardware acceleration, you may have seen artifacts at the stop positions as of 5.1.1 #20814
5.1.1
5.0.3
5.0.2
5.0.1
New Features
-
[Removed API] Removed the
setScale(float)APIs fromLottieAnimationViewandLottieDrawable. The expected behavior was highly ambiguous when paired with other scale types and canvas transformations. For the vast majority of cases, ImageView.ScaleType should be sufficient. For remaining cases, you may apply transformations to Canvas and useLottieDrawable#drawdirectly. -
Added support for the "Rounded Corners" effect on Shape and Rect layers (#1953)
-
Prior to 5.0, LottieAnimationView would always call setLayerType with either HARDWARE or SOFTWARE. In the hardware case, this would case Android to allocate a dedicated hardware buffer for the animation that had to be uploaded to the GPU separately. In the software case, LottieAnimationView would rely on View's internal drawing cache.
This has a few disadvantages:
- The hardware/software distinction happened at the LottieAnimationView level. That means that consumers of LottieDrawable (such as lottie-compose) had no way to
choose a render mode. - Dedicated memory for Lottie was always allocated. In the software case, it would be a bitmap that is the size of the LottieAnimationView and in the hardware case, it was a dedicated hardware layer.
Benefits as a result of this change:
- Reduced memory consumption. In the hardware case, no new memory is allocated. In the software case, Lottie will create a bitmap that is the intersection of your View/Composition bounds mapped with the drawing transformation which often yields a surface are that is smaller than the entire LottieAnimationView.
- lottie-compose now supports setting a RenderMode.
- Custom uses of LottieDrawable now support setting a RenderMode via setRenderMode.
- The hardware/software distinction happened at the LottieAnimationView level. That means that consumers of LottieDrawable (such as lottie-compose) had no way to
-
Lottie can now render outside of its composition bounds. To allow this with views such as LottieAnimationView, set
clipToCompositionBoundsto false onLottieDrawableorLottieAnimationViewandclipChildrento false on the parent view. For Compose, use theclipToCompositionBoundsparameter. -
Prior to 5.0, LottieAnimationView handled all animation controls when the view's visibility or attach state changed. This worked fine for consumers of LottieAnimationView. However, custom uses of LottieDrawable were prone to leaking infinite animators if they did not properly handle cancelling animations correctly. This opens up the possibility for unexpected behavior and increased battery drain. Lottie now behaves more like animated drawables in the platform and moves this logic into the Drawable via its setVisible API. This should lead to no explicit behavior changes if you are using LottieAnimationView. However, if you are using LottieDrawable directly and were explicitly pausing/cancelling animations on lifecycle changes, you may want to cross check your expected behavior with that of LottieDrawable after this update. This change also resolved a long standing bug when Lottie is used in RecyclerViews due to the complex way in which RecyclerView handles View lifecycles (#1495).
#1981 -
Add an API setClipToCompositionBounds on LottieAnimationView, LottieDrawable, and the LottieAnimation composable to prevent Lottie from clipping animations to the composition bounds.
-
Add an API to always render dynamically set bitmaps at the original animation bounds. Previously, dynamically set bitmaps would be rendered at their own size anchored to the top left
of the original bitmap. This meant that if you wanted to supply a lower resolution bitmap to save memory, it would render smaller. The default behavior remains the same but you can
enable setMaintainOriginalImageBounds to be able to supply lower resolution bitmaps (#1706). -
Add support for
LottieProperty.TEXTto use dynamic properties for text. This enables dynamic text support for lottie-compose (#1995). -
Add getters for Marker fields (#1998)
-
Add support for reversed polystar paths (#2003)
Bugs Fixed
- Fix a rare NPE multi-threaded race condition (#1959)
- Don't cache dpScale to support moving Activities between different displays (#1915)
- Fix some cases that would prevent LottieAnimationView or LottieDrawable from being rendered by the Android Studio layout preview (#1984)
- Better handle animations in which there is only a single color in a gradient (#1985)
- Fix a rare race condition that could leak a LottieTask object (#1986)
- Call onAnimationEnd when animations are cancelled to be consistent with platform APIs (#1994)
- Fix a bug that would only render part of a path if the trim path extended from 0-100 and had an offset (#1999)
- Add support for languages that use DIRECTIONALITY_NONSPACING_MARK like Hindi (#2001)
- Prevent LottieAnimationView from overwriting user actions when restoring instance state (#2002)
4.2.1
4.2.0
4.1.0
BREAKING CHANGES
Before this release, drop shadows and blurs were completely ignored. They will now be rendered. In most cases, they will now be rendered correctly. However, you should read the implementation details here if they are not.