Refresh with animation

Author: anconaesselmann

Sources/LoadableView/Extensions/SwiftUI+Extensions.swift

@@ -0,0 +1,16 @@
+//  Created by Axel Ancona Esselmann on 11/8/24.
+//
+
+import SwiftUI
+
+public func withAnimation<Result>(
+    _ animation: Animation? = .default,
+    shouldAnimate: Bool,
+    body: () throws -> Result
+) rethrows -> Result {
+    if shouldAnimate {
+        try withAnimation(animation, body)
+    } else {
+        try body()
+    }
+}

Sources/LoadableView/Protocols/LoadableView/BaseLoadableViewModel.swift

@@ -27,6 +27,10 @@ public protocol BaseLoadableViewModel: ObservableObject, AnyObject {
     func cancel() async
 
     func onLoadingChange(isLoading: Bool)
+
+    func shouldRefresh(_ oldItem: Element?, newItem: Element) async -> Bool
+    
+    func shouldAnimate(_ oldItem: Element?, newItem: Element) async -> Bool
 }
 
 public extension BaseLoadableViewModel {

Sources/LoadableView/Protocols/LoadableView/IDedLoadableViewModel.swift

@@ -84,6 +84,9 @@ public extension IDedLoadableViewModel {
                 throw LoadableViewError.noId
             }
             let item = try await load(id: id)
+            guard await shouldRefresh(viewState.loaded, newItem: item) else {
+                return
+            }
             if let reloadsWhenForegrounding = self as? (any ReloadsWhenForegrounding) {
                 reloadsWhenForegrounding.setLastLoaded()
             }
@@ -92,7 +95,10 @@ public extension IDedLoadableViewModel {
                 viewState = .loaded(item)
             case .loaded(let oldItem):
                 if !equal(oldItem, item) {
-                    viewState = .loaded(item)
+                    let shouldAnimate = await self.shouldAnimate(viewState.loaded, newItem: item)
+                    withAnimation(shouldAnimate: shouldAnimate) {
+                        viewState = .loaded(item)
+                    }
                 }
             }
             setIsLoading(false)
@@ -111,4 +117,12 @@ public extension IDedLoadableViewModel {
             }
         }
     }
+
+    func shouldRefresh(_ oldItem: Element?, newItem: Element) async -> Bool {
+        return true
+    }
+
+    func shouldAnimate(_ oldItem: Element?, newItem: Element) async -> Bool {
+        return true
+    }
 }

Sources/LoadableView/Protocols/LoadableView/LoadableViewModel.swift

@@ -2,6 +2,7 @@
 //
 
 import Foundation
+import SwiftUI
 
 @MainActor
 public protocol LoadableViewModel: BaseLoadableViewModel {
@@ -38,6 +39,9 @@ public extension LoadableViewModel {
         setIsLoading(showLoading)
         do {
             let item = try await load()
+            guard await shouldRefresh(viewState.loaded, newItem: item) else {
+                return
+            }
             if let reloadsWhenForegrounding = self as? (any ReloadsWhenForegrounding) {
                 reloadsWhenForegrounding.setLastLoaded()
             }
@@ -46,7 +50,10 @@ public extension LoadableViewModel {
                 viewState = .loaded(item)
             case .loaded(let oldItem):
                 if !equal(oldItem, item) {
-                    viewState = .loaded(item)
+                    let shouldAnimate = await self.shouldAnimate(viewState.loaded, newItem: item)
+                    withAnimation(shouldAnimate: shouldAnimate) {
+                        viewState = .loaded(item)
+                    }
                 }
             }
             setIsLoading(false)
@@ -61,4 +68,12 @@ public extension LoadableViewModel {
             await refresh(showLoading: showLoading)
         }
     }
+
+    func shouldRefresh(_ oldItem: Element?, newItem: Element) async -> Bool {
+        return true
+    }
+
+    func shouldAnimate(_ oldItem: Element?, newItem: Element) async -> Bool {
+        return true
+    }
 }