lottie-ios

Note: Lottie 3.4.0 added a new rendering engine powered by Core Animation. Please try it out and let us know if you encounter any issues! It will be enabled by default in a future version of Lottie. More information is available in this announcement: https://github.com/airbnb/lottie-ios/discussions/1627

New features

• Added support for Repeater shape items to Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1688)
• Added support for inverted matte layers to Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1712)
• Added fillMode support to GradientFill shape items (https://github.com/airbnb/lottie-ios/pull/1702)
• Added support for non-integer animation widths/heights (https://github.com/airbnb/lottie-ios/pull/1694)

Bug fixes

• Fixed CocoaPods installation issue by removing .swift-version file (https://github.com/airbnb/lottie-ios/pull/1674)
• Changeed default behavior when bundle image is not found from assertionFailure to warn (https://github.com/airbnb/lottie-ios/pull/1680)
• Fixed issue where isAnimationPlaying would be incorrect when using LottieLoopMode.playOnce (https://github.com/airbnb/lottie-ios/pull/1682)
• Fixed regression where InvertedMatteLayers wouldn't animate when using Main Thread rendering engine (https://github.com/airbnb/lottie-ios/pull/1684)
• Core Animation rendering engine now respects LayerModel.hidden and ShapeItem.hidden flags (https://github.com/airbnb/lottie-ios/pull/1689)
• Fixed where strokes would not appear under certain conditions (https://github.com/airbnb/lottie-ios/pull/1691)
• Core Animation rendering engine now supports animating multiple properties of shape bezier paths (https://github.com/airbnb/lottie-ios/pull/1690)
• Core Animation rendering engine now correctly Ignores masks with MaskMode.none (https://github.com/airbnb/lottie-ios/pull/1693)
• Fixed issue where Core Animation engine would render negative stroke offsets incorrectly (https://github.com/airbnb/lottie-ios/pull/1698)
• Improved shape fill behavior for overlapping shapes when using Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1699)
• Fixed issue that caused text layer descenders to be cut off when using some fonts https://github.com/airbnb/lottie-ios/pull/1697
• RenderingEngineOption.automatic now falls back to the Main Thread rendering engine when attempting to apply Trim to Fill (unsupported by Core Animation rendering engine) (https://github.com/airbnb/lottie-ios/pull/1706)
• Fixed bug in AnimationView.play(fromFrame:toFrame:) with fromFrame: nil (https://github.com/airbnb/lottie-ios/pull/1707)
• Fixed issue where some spatial keyframes would be ignored by Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1714)
• Fixed issue where certain AnimationKeypaths were not applied correctly by Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1715)
• Fixed issue where stroke with dash pattern could unexpectedly be rendered as pills instead of circles (https://github.com/airbnb/lottie-ios/pull/1718)
• Fixed issue where large GradientFill / GradientStroke would be cut off when using Core Animation rendering engine (https://github.com/airbnb/lottie-ios/pull/1721)

General

New features

• Added configuration: LottieConfiguration = .shared option to more AnimationView initializers (https://github.com/airbnb/lottie-ios/pull/1654)
• AnimatedSwitch and AnimatedButton are now accessibility elements by default (https://github.com/airbnb/lottie-ios/pull/1637, https://github.com/airbnb/lottie-ios/pull/1639)

Bug fixes

• Fixed issue where LottieLogger.shared.assertionFailure would unexpectedly crash in -O / release builds (https://github.com/airbnb/lottie-ios/pull/1665)
• Fixed Carthage support on macOS (https://github.com/airbnb/lottie-ios/pull/1641)

Core Animation rendering engine

Reminder: Lottie 3.4.0 added a new rendering engine powered by Core Animation. Please try it out and let us know if you encounter any issues! It will be enabled by default in a future version of Lottie. More information is available in this announcement: https://github.com/airbnb/lottie-ios/discussions/1627

New features

• Added support for mixed isHold / !isHold keyframes (https://github.com/airbnb/lottie-ios/pull/1644)
• Added support for gradients with alpha values (https://github.com/airbnb/lottie-ios/pull/1634, https://github.com/airbnb/lottie-ios/pull/1640)
• Added support for negative speed values (https://github.com/airbnb/lottie-ios/pull/1660)

Bug fixes

• Fixed issue where ShapeLayer with no Groups would fail to render (https://github.com/airbnb/lottie-ios/pull/1646)
• Fixed issue where some shape fills would be applied incorrectly (https://github.com/airbnb/lottie-ios/pull/1647)
• Fixed issue where LottieBackgroundBehavior would unexpectedly be applied even when the animation was paused (#1653)

New features

• Added a new animation rendering engine powered by Core Animation (lean more)

  • When using the new rendering engine, Lottie animations now always smoothly regardless of the amount of work being done on the app’s main thread. This significantly improves animation performance while also eliminating CPU overhead.

  • The Core Animation rendering engine is currently opt-in, configured by a feature flag (LottieConfiguration.renderingEngine). In a future major version of Lottie, we plan on enabling the new rendering engine by default.

  • Due to limitations of Core Animation, not all Lottie animation features are supported by the new rendering engine. Lottie includes a RenderingEngineOption.automatic option, which detects if an animation can be played correctly using the new rendering engine and otherwise falls back to the legacy main thread rendering engine:

    // Can be enabled globally:
    //  - Use the Core Animation rendering engine if possible,
    //    otherwise fall back to using the Main Thread rendering engine
    LottieConfiguration.shared.renderingEngine = .automatic
    
    // Or when initializing your Animation View:
    let animationView = AnimationView(
      animation: ...,
      configuration: LottieConfiguration(renderingEngine: .automatic))
    

  • If you encounter any compatibility issues when using RenderingEngineOption.automatic, please file an issue with a copy of your animation json.

• Added new dictionary-based Animation decoding implementation (#1561)

  • 2x faster than the existing Codable decoding implementation

  • There may be some compatibility issues with this implementation, so it is currently opt-in, configured by a feature flag (LottieConfiguration.decodingStrategy):

    // Can be enabled globally:
    LottieConfiguration.shared.decodingStrategy = .dictionaryBased
        
    // Or when initializing your Animation View:
    let animationView = AnimationView(
      animation: ...,
      configuration: LottieConfiguration(decodingStrategy: .dictionaryBased))
    

  • If you encounter any compatibility issues with this new decoding implementation, please file an issue with a copy of your animation json.

• Added blend mode support (#1585)

• Added LottieLogger type that allows for customizing how Lottie outputs log messages (#1474)

• Add keyframe animation support to ValueProviders API (#1491)

• Added support for loading images stored in Asset Catalogs (#1511)

• Added support for accessing the original value of an AnimationKeypath (#1559)

• Added support for loading animations with “.json” file extension in name (#1561)

Bug fixes

• Improved performance of Gradient Fill layers (#1558)
• Fixed Carthage support (#1496)
• Avoid automatic animations for rapid opacity changes (#1397)
• Fixed GroupNode empty transform issue (#1372)
• Fixed nil host warning when data url is base64 encoded (#1524)
• Fixed issue where frame parameter was ignored in AnimationView.init(frame:) initializer (#1527)
• Fixed issue with Polygon rendering (#1537)
• Fixed issue where layer(for: keypath) could unexpectedly return nil (#1587)
• Improved performance of BundleImageProvider by caching images (#1590)
• Improved performance of InvertedMatteLayer (#1388)

Full Changelog: https://github.com/airbnb/lottie-ios/compare/3.2.3...3.3.0

• Increased minimum deployment target to iOS 11
• Added Swift Package Manager support for macOS and tvOS (#1428)
• Added parsing support for layers with no index (ind) property (#1433)
• AnimatedSwitch and AnimatedButton are now open instead of final (#1431)
• Fixed issue where shape layers could render at a low resolution (#1436)
• Fixed issue where AnimationView's transform could animate incorrectly (#1395)

Known issues:

• 3.3.0 doesn't support Carthage (#1448, fixed on master and in future releases)

Adds a fix for a bug that caused precomposition layers to have zero sized bounds. This bug furth broke alpha inverted masks in precomposition layers.

A few fixes here including:

• Removing Swift warnings
• Performance fixes

Various Bug Fixes

Various bug fixes and improvements

• Add isAnimationPlaying to CompatibleAnimationView
• change id accessor from internal to public
• Updates to Text Rendering
• fix: empty layerID causes crash
• Rewrite Text Rendering to support Line Height + Added Font Provider
• fixed #944 Images from Assets.xcassets are not loading
• Work Around Xcode 12 Beta 1 Compilation Issues
• Add isAnimationQueued to determine if animation will start when this view is added to a window
• Changed ACL for animationView to public in AnimatedControl

Fixes a compile error introduced with 3.1.7 release

• Swift 5 (Thanks https://github.com/airbnb/lottie-ios/commits?author=thejohnlima !)
• Gradient Value Provider support (Thanks https://github.com/airbnb/lottie-ios/commits?author=enriquebk !)
• Precomp clipping fix
• Swift packages fixes
• Layout bug fix (Thanks https://github.com/airbnb/lottie-ios/commits?author=MariuszWisniewski )
• Crashing remove observer bug fix (Thanks https://github.com/airbnb/lottie-ios/commits?author=zenangst )

Various improvements and bug fixes.

This fixes a few bugs as well as adds support for animationSpeed setting on AnimatedControl

• Various bug fixes
• Added new API for cropping animations at runtime viewportFrame
• Added new API for enabling/disabling nodes at runtime setNodeIsEnabled(isEnabled:, keypath:)

• Various bug fixes

Minor improvements and bug fixes.

Adds support for swift 5.

Various bug fixes / Improvements

• Fixes a Bug with Animated Switch
• Various Bug Fixes

Added fix for content mode.