Add rendering animation.

Author: colinc86

README.md

@@ -23,7 +23,7 @@ A SwiftUI view that renders LaTeX equations.
       - [Format Equation Number](#format-equation-number)
     - [Unencode HTML](#🔗-unencode-html)
     - [Rendering Style](#🕶️-rendering-style)
-    - [Animated](#🪩-animated)
+    - [Rendering Animation](#🪩-animated)
   - [Caching](#🗄️-caching)
   - [Preloading](#🏃‍♀️-preloading)
 
@@ -47,7 +47,7 @@ It won't
 Add the dependency to your package manifest file.
 
 ```swift
-.package(url: "https://github.com/colinc86/LaTeXSwiftUI", from: "1.2.1")
+.package(url: "https://github.com/colinc86/LaTeXSwiftUI", from: "1.2.2")
 ```
 
 ## ⌨️ Usage
@@ -237,14 +237,14 @@ The view has four rendering styles. The `wait` style is the default style, and l
 | `wait`     | No           | *(default)* The view blocks the main queue until its finished rendering. |
 
 
-#### 🪩 Animated
+#### 🪩 Rendering Animation
 
-The `animated` modifier applies to the view when using the asynchronous rendering styles `empty`, `original`, or `progress`.
+When using the asynchronous rendering styles `empty`, `original`, or `progress`, use this modifier to determine the animation applied to the transition between views. The default value is `none`.
 
 ```swift
 LaTeX(input)
   .renderingStyle(.original)
-  .animated()
+  .renderingAnimation(.easeIn)
 ```
 
 > In the above example, the input text will be displayed until the SVGs have been rendered at which point the rendered views will animate in to view.

Sources/LaTeXSwiftUI/Extensions/EnvironmentValues+Extensions.swift

@@ -70,8 +70,8 @@ private struct RenderingStyleKey: EnvironmentKey {
   static let defaultValue: LaTeX.RenderingStyle = .wait
 }
 
-private struct AnimatedKey: EnvironmentKey {
-  static let defaultValue: Bool = false
+private struct RenderingAnimationKey: EnvironmentKey {
+  static let defaultValue: Animation? = .none
 }
 
 extension EnvironmentValues {
@@ -143,9 +143,9 @@ extension EnvironmentValues {
   }
 
   /// Whether or not rendering should be animated.
-  var animated: Bool {
-    get { self[AnimatedKey.self] }
-    set { self[AnimatedKey.self] = newValue }
+  var renderingAnimation: Animation? {
+    get { self[RenderingAnimationKey.self] }
+    set { self[RenderingAnimationKey.self] = newValue }
   }
 
 }

Sources/LaTeXSwiftUI/Extensions/View+Extensions.swift

@@ -154,12 +154,12 @@ public extension View {
     environment(\.renderingStyle, style)
   }
 
-  /// Sets whether or not the view will animate its render state changes.
+  /// Sets the animation the view should apply to its rendered images.
   ///
-  /// - Parameter animate: Whether animations are enabled.
-  /// - Returns: A view that animates its rendering.
-  func animated(_ animate: Bool = true) -> some View {
-    environment(\.animated, animate)
+  /// - Parameter animation: The animation.
+  /// - Returns: A view that animates its rendered state.
+  func renderingAnimation(_ animation: Animation?) -> some View {
+    environment(\.renderingAnimation, animation)
   }
 
 }

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -145,8 +145,8 @@ public struct LaTeX: View {
   /// The view's rendering style.
   @Environment(\.renderingStyle) private var renderingStyle
 
-  /// Whether or not rendering should be animated.
-  @Environment(\.animated) private var animated
+  /// The animation the view should apply to its rendered images.
+  @Environment(\.renderingAnimation) private var renderingAnimation
 
   /// The view's current display scale.
   @Environment(\.displayScale) private var displayScale
@@ -188,24 +188,27 @@ public struct LaTeX: View {
   // MARK: View body
 
   public var body: some View {
-    if renderState.rendered {
-      bodyWithBlocks(renderState.blocks)
-    }
-    else {
-      switch renderingStyle {
-      case .empty:
-        Text("")
-          .task(render)
-      case .original:
-        Text(latex)
-          .task(render)
-      case .progress:
-        ProgressView()
-          .task(render)
-      case .wait:
-        bodyWithBlocks(syncBlocks)
+    VStack(spacing: 0) {
+      if renderState.rendered {
+        bodyWithBlocks(renderState.blocks)
+      }
+      else {
+        switch renderingStyle {
+        case .empty:
+          Text("")
+            .task(render)
+        case .original:
+          Text(latex)
+            .task(render)
+        case .progress:
+          ProgressView()
+            .task(render)
+        case .wait:
+          bodyWithBlocks(syncBlocks)
+        }
       }
     }
+    .animation(renderingAnimation, value: renderState.rendered)
   }
 
 }
@@ -229,7 +232,6 @@ extension LaTeX {
   /// Renders the view's components.
   @Sendable private func render() async {
     await renderState.render(
-      animated: animated,
       unencodeHTML: unencodeHTML,
       parsingMode: parsingMode,
       font: font,
@@ -375,11 +377,12 @@ struct LaTeX_Previews: PreviewProvider {
 
       LaTeX("Hello, $\\LaTeX$!")
         .renderingStyle(.original)
+        .renderingAnimation(.default)
 
       LaTeX("Hello, $\\LaTeX$!")
         .renderingStyle(.progress)
+        .renderingAnimation(.easeIn)
     }
-    .animated()
     .previewDisplayName("Rendering Style and Animated")
   }
 

Sources/LaTeXSwiftUI/Models/LaTeXRenderState.swift

@@ -59,27 +59,19 @@ extension LaTeXRenderState {
   /// Renders the views components.
   ///
   /// - Parameters:
-  ///   - animated: The `animated` environment variable.
   ///   - unencodeHTML: The `unencodeHTML` environment variable.
   ///   - parsingMode: The `parsingMode` environment variable.
   ///   - font: The `font environment` variable.
   ///   - displayScale: The `displayScale` environment variable.
   ///   - texOptions: The `texOptions` environment variable.
-  func render(animated: Bool, unencodeHTML: Bool, parsingMode: LaTeX.ParsingMode, font: Font?, displayScale: CGFloat, texOptions: TeXInputProcessorOptions) async {
+  func render(unencodeHTML: Bool, parsingMode: LaTeX.ParsingMode, font: Font?, displayScale: CGFloat, texOptions: TeXInputProcessorOptions) async {
     let isRen = await isRendering
     let ren = await rendered
     guard !isRen && !ren else {
       return
     }
     await MainActor.run {
-      if animated {
-        withAnimation {
-          isRendering = true
-        }
-      }
-      else {
-        isRendering = true
-      }
+      isRendering = true
     }
 
     let renderedBlocks = await Renderer.shared.render(
@@ -89,18 +81,9 @@ extension LaTeXRenderState {
       texOptions: texOptions)
 
     await MainActor.run {
-      if animated {
-        withAnimation {
-          blocks = renderedBlocks
-          isRendering = false
-          rendered = true
-        }
-      }
-      else {
-        blocks = renderedBlocks
-        isRendering = false
-        rendered = true
-      }
+      blocks = renderedBlocks
+      isRendering = false
+      rendered = true
     }
   }