Added reloadRow() reloadRows() and reloadAllRows() methods

Author: malcommac

ScrollStackController.xcodeproj/project.xcworkspace/xcuserdata/daniele.xcuserdatad/UserInterfaceState.xcuserstate

@@ -10,7 +10,7 @@ import UIKit
 
 public class VC1: UIViewController, ScrollStackContainableController {
 
-    private var bestSize = CGFloat.random(in: 100..<500)
+    public var bestSize = CGFloat.random(in: 100..<500)
 
     public static func create(backColor: UIColor) -> VC1 {
         let storyboard = UIStoryboard(name: "Main", bundle: nil)
@@ -19,8 +19,12 @@ public class VC1: UIViewController, ScrollStackContainableController {
         return vc
     }
 
-    public func sizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat? {
+    public func scrollStackRowSizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat? {
         return bestSize
     }
 
+    public func reloadContentFromStackViewRow() {
+        
+    }
+    
 }

ScrollStackControllerDemo/VC1.swift

@@ -10,15 +10,20 @@ import UIKit
 
 public class VC2: UIViewController, ScrollStackContainableController {
 
+    
     public static func create(backColor: UIColor) -> VC2 {
         let storyboard = UIStoryboard(name: "Main", bundle: nil)
         let vc = storyboard.instantiateViewController(identifier: "VC2") as! VC2
         vc.view.backgroundColor = backColor
         return vc
     }
 
-    public func sizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat? {
+    public func scrollStackRowSizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat? {
         return 140
     }
 
+    public func reloadContentFromStackViewRow() {
+        
+    }
+    
 }

ScrollStackControllerDemo/VC2.swift

@@ -40,9 +40,13 @@ class ViewController: UIViewController {
     @IBAction public func toggleAxis() {
         let stackView = stackController.stackView
 
-        let randomVC = VC2.create(backColor: UIColor.random())
-        let position = Int.random(in: 0..<stackView.rows.count)
-        stackView.addRow(controller: randomVC, at: .atIndex(position), animated: true)
+//        let randomVC = VC2.create(backColor: UIColor.random())
+//        let position = Int.random(in: 0..<stackView.rows.count)
+//        stackView.addRow(controller: randomVC, at: .atIndex(position), animated: true)
+        
+        (stackView.rows[0].controller as! VC1).bestSize = 50
+        (stackView.rows[1].controller as! VC1).bestSize = 30
+        stackController.stackView.reloadRows(indexes: [0,1], animated: true)
 
 
 //        stackController.stackView.setRowHidden(index: 0, isHidden: true, animated: true)

ScrollStackControllerDemo/ViewController.swift

@@ -262,6 +262,37 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
 
         }
     }
+    
+    // MARK: - Reload Rows
+    
+    /// Perform a reload method by updating any constraint of the stack view's row.
+    /// If row's managed controller implements `ScrollStackContainableController` it also call
+    /// the reload event.
+    ///
+    /// - Parameter index: index of the row to reload.
+    /// - Parameter animated: `true` to animate reload (any constraint change).
+    /// - Parameter completion: optional completion callback to call.
+    open func reloadRow(index: Int, animated: Bool = false, completion: (() -> Void)? = nil) {
+        reloadRows(indexes: [index], animated: animated, completion: completion)
+    }
+    
+    /// Perform a reload method on multiple rows.
+    ///
+    /// - Parameter indexes: indexes of the rows to reload.
+    /// - Parameter animated: `true` to animate reload (any constraint change).
+    /// - Parameter completion:  optional completion callback to call.
+    open func reloadRows(indexes: [Int], animated: Bool = false, completion: (() -> Void)? = nil) {
+        let selectedRows = safeRowsAtIndexes(indexes)
+        reloadRows(selectedRows, animated: animated, completion: completion)
+    }
+    
+    /// Reload all rows of the stack view.
+    ///
+    /// - Parameter animated: `true` to animate reload (any constraint change).
+    /// - Parameter completion: optional completion callback to call.
+    open func reloadAllRows(animated: Bool = false, completion: (() -> Void)? = nil) {
+        reloadRows(rows, animated: animated, completion: completion)
+    }
 
     // MARK: - Remove Rows
 
@@ -318,12 +349,12 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
 
         stackView.setNeedsLayout()
 
-        UIView.animate({
+        UIView.execute({
             sourceRow.isHidden = true
         }) {
             let newRow = self.createRowForController(controller, insertAt: sourceIndex, animated: false)
             newRow.isHidden = true
-            UIView.animate({
+            UIView.execute({
                 newRow.isHidden = false
             }, completion: completion)
         }
@@ -358,7 +389,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         }
 
         stackView.setNeedsLayout()
-        UIView.animate(executeMoveRow, completion: completion)
+        UIView.execute(executeMoveRow, completion: completion)
     }
 
     // MARK: Show/Hide Rows
@@ -385,7 +416,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         }
 
         row.layoutIfNeeded()
-        UIView.animate({
+        UIView.execute({
             row.isHidden = isHidden
         }, completion: completion)
     }
@@ -458,7 +489,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
             return .hidden
         }
 
-        return isRowVisible(row: row)
+        return rowVisibilityType(row: row)
     }
 
     /// Return `true` if row is currently hidden.
@@ -530,14 +561,48 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         didChangeAxis(axis)
     }
 
+    /// Reload selected rows of the stackview.
+    ///
+    /// - Parameter rows: rows to reload.
+    /// - Parameter animated: `true` to animate reload.
+    /// - Parameter completion: completion callback to call at the end of the reload.
+    private func reloadRows(_ rows: [ScrollStackRow], animated: Bool = false, completion: (() -> Void)? = nil) {
+        guard rows.isEmpty == false else {
+            return
+        }
+        
+        rows.forEach {
+            $0.askForCutomizedSizeOfContentView()
+        }
+        
+        UIView.execute(animated: animated, {
+            self.layoutIfNeeded()
+        }, completion: completion)
+    }
+    
+    /// Get the row at specified index; if index is invalid `nil` is returned.
+    ///
+    /// - Parameter index: index of the row to get.
     private func safeRowAtIndex(_ index: Int) -> ScrollStackRow? {
-        guard index >= 0, index < rows.count else {
-            return nil
+        return safeRowsAtIndexes([index]).first
+    }
+    
+    /// Get the rows at specified indexes, invalid indexes are ignored.
+    ///
+    /// - Parameter indexes: indexes of the rows to get.
+    private func safeRowsAtIndexes(_ indexes: [Int]) -> [ScrollStackRow] {
+        return indexes.compactMap { index in
+            guard index >= 0, index < rows.count else {
+                return nil
+            }
+            return rows[index]
         }
-        return rows[index]
     }
 
-    private func isRowVisible(row: ScrollStackRow) -> RowVisibility {
+    /// Get the row visibility type for a specific row.
+    ///
+    /// - Parameter row: row to get.
+    private func rowVisibilityType(row: ScrollStackRow) -> RowVisibility {
         let rowFrame = convert(row.frame, to: self)
         guard bounds.intersects(rowFrame) else {
             return .offscreen
@@ -597,7 +662,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         postInsertRow(newRow, animated: animated, completion: completion)
 
         if animated {
-            UIView.animate({
+            UIView.execute({
                 self.layoutIfNeeded()
             }, completion: nil)
         }
@@ -620,6 +685,9 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         animateCellVisibility(row, animated: animated, hide: false, completion: completion)
     }
 
+    /// Update the separator visibility.
+    ///
+    /// - Parameter row: row target.
     private func updateRowSeparatorVisibility(_ row: ScrollStackRow?) {
         guard let row = row, row === stackView.arrangedSubviews.last else {
             return
@@ -653,6 +721,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         }
     }
 
+    /// Animate transition of the cell to visible state.
     private func animateCellToVisibleState(_ row: ScrollStackRow, animated: Bool, hide: Bool, completion: (() -> Void)? = nil) {
         guard animated else {
             row.alpha = 1.0
@@ -663,28 +732,26 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
 
         row.alpha = 0.0
         layoutIfNeeded()
-        UIView.animate({
+        UIView.execute({
             row.alpha = 1.0
         }, completion: completion)
     }
 
+    /// Animate transition of the cell to invisibile state.
     private func animateCellToInvisibleState(_ row: ScrollStackRow, animated: Bool, hide: Bool, completion: (() -> Void)? = nil) {
-        guard animated else {
-            row.isHidden = true
-            completion?()
-            return
-        }
-        
-        UIView.animate({
+        UIView.execute(animated: animated, {
             row.isHidden = true
         }, completion: completion)
     }
 
     // MARK: - Axis Change Events
 
+    /// Update the constraint due to axis change of the stack view.
+    ///
+    /// - Parameter axis: new axis.
     private func didChangeAxis(_ axis: NSLayoutConstraint.Axis) {
         didUpdateStackViewAxisTo(axis)
-        didUpdateCellAxisTo(axis)
+        didReflectAxisChangeToRows(axis)
     }
 
     private func didUpdateStackViewAxisTo(_ axis: NSLayoutConstraint.Axis) {
@@ -708,7 +775,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         axisConstraint?.isActive = true
     }
 
-    private func didUpdateCellAxisTo(_ axis: NSLayoutConstraint.Axis) {
+    private func didReflectAxisChangeToRows(_ axis: NSLayoutConstraint.Axis) {
         rows.forEach {
             $0.separatorAxis = (axis == .horizontal ? .vertical : .horizontal)
         }

Sources/ScrollStackController/ScrollStack.swift

@@ -251,7 +251,7 @@ open class ScrollStackRow: UIView, UIGestureRecognizerDelegate {
         }
 
         let currentAxis = stackView!.axis
-        guard let bestSize = customizableController.sizeForAxis(currentAxis, row: self, in: self.stackView!) else {
+        guard let bestSize = customizableController.scrollStackRowSizeForAxis(currentAxis, row: self, in: self.stackView!) else {
             return // ignore, use autolayout in place for content view.
         }
 

Sources/ScrollStackController/ScrollStackRow.swift

@@ -49,7 +49,10 @@ public protocol ScrollStackContainableController: UIViewController {
     /// - Parameter axis: axis of the stackview.
     /// - Parameter row: row where the controller is placed.
     /// - Parameter stackView: stackview where the row is placed.
-    func sizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat?
+    func scrollStackRowSizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> CGFloat?
+    
+    /// Method is called when you call a `reloadRow` function on a row where this controller is contained in.
+    func reloadContentFromStackViewRow()
 
 }
 

Sources/ScrollStackController/Support/ScrollStack+Protocols.swift

@@ -65,7 +65,13 @@ extension UIView {
         }
     }
 
-    public static func animate(_ callback: @escaping (() -> Void), completion: (() -> Void)? = nil) {
+    public static func execute(animated: Bool = true, _ callback: @escaping (() -> Void), completion: (() -> Void)? = nil) {
+        guard animated else {
+            callback()
+            completion?()
+            return
+        }
+        
         UIView.animate(withDuration: 0.3, animations: callback) { isFinished in
             if isFinished {
                 completion?()