Add LottieView.animationDidLoad API (airbnb#2172)

MoroziOS · May 22, 2024 · ccd3ffb · ccd3ffb
1 parent d2e5a90
commit ccd3ffb
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/Example/Example/AnimationPreviewView.swift b/Example/Example/AnimationPreviewView.swift
@@ -6,7 +6,6 @@ import SwiftUI
 
 // MARK: - AnimationPreviewView
 
-/// TODO: Implement functionality from UIKit `AnimationPreviewViewController`
 struct AnimationPreviewView: View {
 
   // MARK: Lifecycle

diff --git a/Lottie.xcodeproj/xcshareddata/xcschemes/Lottie (visionOS).xcscheme b/Lottie.xcodeproj/xcshareddata/xcschemes/Lottie (visionOS).xcscheme
@@ -15,7 +15,7 @@
             <BuildableReference
                BuildableIdentifier = "primary"
                BlueprintIdentifier = "080DEF612A95707B00BE2D96"
-               BuildableName = "Lottie_visionOS.framework"
+               BuildableName = "Lottie.framework"
                BlueprintName = "Lottie-visionOS"
                ReferencedContainer = "container:Lottie.xcodeproj">
             </BuildableReference>
@@ -50,7 +50,7 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "080DEF612A95707B00BE2D96"
-            BuildableName = "Lottie_visionOS.framework"
+            BuildableName = "Lottie.framework"
             BlueprintName = "Lottie-visionOS"
             ReferencedContainer = "container:Lottie.xcodeproj">
          </BuildableReference>

diff --git a/Sources/Public/Animation/LottieView.swift b/Sources/Public/Animation/LottieView.swift
@@ -117,7 +117,8 @@ public struct LottieView<Placeholder: View>: UIViewConfiguringSwiftUIView {
     ZStack {
       if let animationSource = animationSource {
         LottieAnimationView.swiftUIView {
-          LottieAnimationView(
+          defer { animationDidLoad?(animationSource) }
+          return LottieAnimationView(
             animationSource: animationSource,
             imageProvider: imageProvider,
             textProvider: textProvider,
@@ -132,6 +133,7 @@ public struct LottieView<Placeholder: View>: UIViewConfiguringSwiftUIView {
           // prohibitive to do so on every state update.
           if animationSource.animation !== context.view.animation {
             context.view.loadAnimation(animationSource)
+            animationDidLoad?(animationSource)
           }
 
           if
@@ -190,6 +192,14 @@ public struct LottieView<Placeholder: View>: UIViewConfiguringSwiftUIView {
     return copy
   }
 
+  /// Returns a copy of this view with the given closure that is called whenever the
+  /// `LottieAnimationSource` provided via `init` is loaded and applied to the underlying `LottieAnimationView`.
+  public func animationDidLoad(_ animationDidLoad: @escaping (LottieAnimationSource) -> Void) -> Self {
+    var copy = self
+    copy.animationDidLoad = animationDidLoad
+    return copy
+  }
+
   /// Returns a copy of this view with the given `LottieCompletionBlock` that is called
   /// when an animation finishes playing.
   public func animationDidFinish(_ animationCompletionHandler: LottieCompletionBlock?) -> Self {
@@ -406,6 +416,7 @@ public struct LottieView<Placeholder: View>: UIViewConfiguringSwiftUIView {
   private var playbackMode: LottiePlaybackMode?
   private var reloadAnimationTrigger: AnyEquatable?
   private var loadAnimation: (() async throws -> LottieAnimationSource?)?
+  private var animationDidLoad: ((LottieAnimationSource) -> Void)?
   private var animationCompletionHandler: LottieCompletionBlock?
   private var showPlaceholderWhileReloading = false
   private var imageProvider: AnimationImageProvider?