Reflected reviews

Author: ArLupin

Example/AloeStackViewExample/Views/CustomAnimatingLabel.swift

@@ -17,16 +17,20 @@ import UIKit
 import AloeStackView
 
 public class CustomAnimatingLabel: UILabel, CustomAnimating {
-
-  public func willAnimate(with coordinator: AnimationCoordinator) {
-    let isInsertState = coordinator.state == .insert
-    transform = isInsertState ? CGAffineTransform(translationX: -100, y: 0) : .identity
-    alpha = isInsertState ? 0 : 1
-
-    coordinator.animate(alongsideAnimation: {
-      self.transform = isInsertState ? .identity : CGAffineTransform(translationX: -100, y: 0)
-      self.alpha = isInsertState ? 1 : 0
-    })
-  }
+    
+    public func animateInsert() {
+        transform = .identity
+        alpha = 1
+    }
+    
+    public func insertAnimationWillBegin() {
+        transform = CGAffineTransform(translationX: -100, y: 0)
+        alpha = 0
+    }
+
+    public func animateRemove() {
+        transform = CGAffineTransform(translationX: -100, y: 0)
+        alpha = 0
+    }
 
 }

Sources/AloeStackView/AloeStackView.swift

@@ -237,7 +237,7 @@ open class AloeStackView: UIScrollView {
     guard let cell = row.superview as? StackViewCell, cell.isHidden != isHidden else { return }
 
     if animated {
-      let state: State = isHidden ? .delete : .insert
+      let state: State = isHidden ? .remove : .insert
       let coordinator = AnimationCoordinator(target: cell, state: state, animations: {
         cell.isHidden = isHidden
         cell.layoutIfNeeded()
@@ -575,7 +575,7 @@ open class AloeStackView: UIScrollView {
     }
 
     if animated {
-      let coordinator = AnimationCoordinator(target: cell, state: .delete, animations: {
+      let coordinator = AnimationCoordinator(target: cell, state: .remove, animations: {
         cell.isHidden = true
       }, completion: completion)
       coordinator.startAnimation()

Sources/AloeStackView/Animation/AnimationCoordinator.swift

@@ -16,9 +16,9 @@
 import UIKit
 
 /**
- * An object that animates when the Row is inserted and deleted from the AloeStackView.
+ * An object that animates when the Row is inserted and removed from the AloeStackView.
  */
-public class AnimationCoordinator {
+internal class AnimationCoordinator {
 
   // MARK: Internal
 
@@ -30,34 +30,52 @@ public class AnimationCoordinator {
   }
 
   internal func startAnimation() {
-    (target.contentView as? CustomAnimating)?.willAnimate(with: self)
-    UIView.animate(withDuration: AnimationCoordinator.defaultAnimationDuration, animations: {
+    let config = target.contentView as? CustomAnimating
+
+    willBeginAnimation?()
+
+    UIView.animate(withDuration: AnimationCoordinator.defaultAnimationDuration,
+                   delay: 0,
+                   usingSpringWithDamping: config?.springDamping ?? 1,
+                   initialSpringVelocity: 0,
+                   options: [.curveEaseInOut, .allowUserInteraction, .beginFromCurrentState],
+                   animations: {
+      self.animate?()
       self.animations()
-      self.alongsideAnimation?()
-    }) { success in
-      self.completion?(success)
-      self.alongsideCompletion?(success)
+    }) { finished in
+      self.animationDidEnd?(finished)
+      self.completion?(finished)
     }
   }
 
-  // MARK: Public
-
-  public let state: State
-
-  /// AloeStackView gives you the opportunity to change state values ​​by taking over the animation behavior when Row is added and removed.
-  public func animate(alongsideAnimation animation: (() -> Void)?, completion: ((Bool) -> Void)? = nil) {
-    alongsideAnimation = animation
-    alongsideCompletion = completion
-  }
 
   // MARK: Private
 
   private let target: StackViewCell
+  private let state: State
   private let animations: () -> Void
   private let completion: ((Bool) -> Void)?
 
-  private var alongsideAnimation: (() -> Void)?
-  private var alongsideCompletion: ((Bool) -> Void)?
+  private lazy var willBeginAnimation: (() -> Void)? = {
+    switch state {
+    case .insert: return (target.contentView as? CustomAnimating)?.insertAnimationWillBegin
+    case .remove: return (target.contentView as? CustomAnimating)?.removeAnimationWillBegin
+    }
+  }()
+    
+  private lazy var animate: (() -> Void)? = {
+    switch state {
+    case .insert: return (target.contentView as? CustomAnimating)?.animateInsert
+    case .remove: return (target.contentView as? CustomAnimating)?.animateRemove
+    }
+  }()
+    
+  private lazy var animationDidEnd: ((Bool) -> Void)? = {
+    switch state {
+    case .insert: return (target.contentView as? CustomAnimating)?.insertAnimationDidEnd
+    case .remove: return (target.contentView as? CustomAnimating)?.removeAnimationDidEnd
+    }
+  }()
 
   private static let defaultAnimationDuration: TimeInterval = 0.3
 

Sources/AloeStackView/Animation/State.swift

@@ -14,12 +14,12 @@
 // limitations under the License.
 
 /**
- * Indicates that the row is added and removed from the AloeStackView.
+ * Indicates that the row is inserted and removed from the AloeStackView.
  */
-public enum State {
+internal enum State {
 
   case insert
 
-  case delete
+  case remove
 
 }

Sources/AloeStackView/Protocols/CustomAnimating.swift

@@ -17,11 +17,55 @@
  * The rows in `AloeStackView` help Custom Animation to work.
  *
  * Rows that are added to an `AloeStackView` can conform to this protocol to have their
- * You can freely change the state animation of each contentView when a row is inserted or deleted.
+ * You can freely change the state animation of each contentView when a row is inserted or removed.
  */
+
+import UIKit
+
 public protocol CustomAnimating {
 
-  /// Invoked when animated is true when inserting or deleting.
-  func willAnimate(with coordinator: AnimationCoordinator)
+  /// The springDamping value used to determine the amount of 'bounce'
+  /// seen when animationing to insert or remove state
+  ///
+  /// Default Value is 0.8.
+  var springDamping: CGFloat { get }
+
+  /// Called before insert animation is activated.
+  func insertAnimationWillBegin()
+
+  /// Called when insert animation is working.
+  func animateInsert()
+
+  /// Called after insert animation.
+  func insertAnimationDidEnd(_ finished: Bool)
+    
+  /// Called before remove animation is activated.
+  func removeAnimationWillBegin()
+    
+  /// Called when remove animation is working.
+  func animateRemove()
+    
+  /// Called after remove animation.
+  func removeAnimationDidEnd(_ finished: Bool)
+
+}
+
+public extension CustomAnimating where Self: UIView {
+
+  var springDamping: CGFloat {
+    return 0.8
+  }
+
+  func animateInsert() { }
+
+  func insertAnimationWillBegin() { }
+
+  func insertAnimationDidEnd(_ finished: Bool) { }
+
+  func animateRemove() { }
+
+  func removeAnimationWillBegin() { }
+
+  func removeAnimationDidEnd(_ finished: Bool) { }
 
 }