Added other docs, implemented visibleRows, enterlyVisibleRows and isEmpty methods

Author: malcommac

README.md

@@ -16,7 +16,11 @@ You can think of it as `UITableView` but with several differences:
 - System Requirements
 - How to use it
 	- Adding Rows
-	- Removing Rows
+	- Removing / Replacing Rows
+	- Move Rows
+	- Hide / Show Rows
+	- Reload Rows
+	- Sizing Rows
 
 ### Main Features
 
@@ -66,6 +70,23 @@ Each row managed by `ScrollStack` is a subclass of `ScrollStackRow`: it strongly
 
 You don't need to handle lifecycle of your rows/view controller until they are part of the rows inside the stack.
 
+To get the list of rows of the stack you can use the `rows` property.
+
+```swift
+// Standard methods
+let allRows = scrollStack.rows
+let isEmpty = scrollStack.isEmpty // true if it does not contains row
+let notHiddenRows = scrollStack.rows.filter { !$0.isHidden }
+
+// By Vibility
+let currentlyVisibleRows = scrollStack.visibleRows // only currently visible rows (partially or enterly)
+let enterlyVisibleRows = scrollStack.enterlyVisibleRows // only enterly visible rows into the stack
+
+// Shortcuts
+let firstRow = scrollStack.firstRow
+let lastRow = scrollStack.lastRow
+```
+
 Let's take a look below.
 
 #### Adding Rows
@@ -94,6 +115,96 @@ The following code add a rows with the view of each view controller passed:
    stackView.addRows(controllers: [welcomeVC, notesVC, tagsVC, galleryVC], animated: false)
 ```
 
-As you noted there is not need to keep a strong reference to any view controller; they are automatically strong referenced by each row created to add them into the stack.
+As you noticed there is not need to keep a strong reference to any view controller; they are automatically strong referenced by each row created to add them into the stack.
+
+#### Removing / Replacing Rows
+
+A similar set of APIs are used to remove existing rows from the stack:
+
+- `removeAllRows(animated:)`: to remove all rows of the stack.
+- `removeRow(index:animated:) -> UIViewController?`: to remove a specific row at given index. It returns a reference to removed view controller.
+- `removeRows(indexes:animated:) -> [UIViewController]?`: to remove rows at specified indexes from the stack. Removed managed `UIViewController` instances are returned.
+- `replaceRow(index:withRow:animated:completion:)`: replace an existing row with a new row which manage new passed view controller.
+
+An example:
+
+```swift
+let newVC: UIViewController = ...
+stackView.replaceRow(index: 1, withRow: galleryVC, animated: true) {
+	print("Gallery controller is now in place!!")
+}
+```
+
+#### Move Rows
+
+If you need to adjust the hierarchy of the stack by moving a row from a position to another you can use:
+
+- `moveRow(index:to:animated:completion:)`: move a row at passed inside to another index (both of indexes must be valid).
+
+The following method move the first row at a random position, by animating the transition:
+
+```swift
+let randomDst = Int.random(in: 1..<stackView.rows.count)
+stackView.moveRow(index: 0, to: randomDst, animated: true, completion: nil)
+```
+
+#### Hide / Show Rows
+
+`ScrollStack` uses the power of `UIStackView`: you can show and hide rows easily with a gorgeous animation by using one of the following methods:
+
+- `setRowHidden(index:isHidden:animated:completion:)`: hide or show a row at index.
+- `setRowsHidden(indexes:isHidden:animated:completion:)`: hide or show multiple rows at specified indexes.
+
+Example:
+
+```swift
+stackView.setRowsHidden(indexes: [0,1,2], isHidden: true, animated: true)
+```
+
+Keep in mind: when you hide a rows the row still part of the stack and it's not removed, just hidden! If you get the list of rows by calling `rows` property of the `ScrollStack` you still see it.
+
+#### Reload Rows
+
+Reload rows method allows you to refresh the layout of the entire stack (using `layoutIfNeeded()`) while you have a chance to update a specific row's `contentView` (aka the view of the managed `UIViewController`).
+
+There are three methods:
+
+- `reloadRow(index:animated:completion:)`: reload a specific row at index.
+- `reloadRows(indexes:animated:completion:)`: reload a specific set of rows.
+- `reloadAllRows(animated:completion:)`: reload all rows.
+
+If your `UIViewController` implements `ScrollStackContainableController` protocol you will get notified inside the class about this request, so you have the opportunity to refresh your data:
+
+Example:
+
+```swift
+class MyViewController: UIViewController {
+
+	private let scrollStackController = ScrollStackController()
+	
+	@IBAction func someAction() {
+		scrollStackController.stackView.reloadRow(0)
+	}
+
+}
+
+// Your row 0 manages the GalleryVC, so in your GalleryVC implementation:
+
+class GalleryVC: UIViewController, ScrollStackContainableController {
+
+    public func func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+		// update your UI
+	}
+	
+}
+```
+
+#### Sizing Rows
+
+You can control the size of your `UIViewController` inside a row of a `ScrollStack` in two ways:
+
+- Creating contrains in your `UIViewController`'s view with Autolayout.
+- Implementing `ScrollStackContainableController` protocol in your `UIViewController` class and return a non `nil` value in `scrollStackRowSizeForAxis(:row:in:) -> ScrollStack.ControllerSize?` delegate method.
+
+In both case `ScrollStack` class will use only one dimension depending by the active scroll axis to layout the view controller content into the stack (if scroll axis is `horizontal` you can control only the `height` of the row, if it's `vertical` only the `width`. The other dimension will be the same of the scroll stack itself.
 
-#### Removing Rows

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

@@ -35,8 +35,8 @@ public class GalleryVC: UIViewController, ScrollStackContainableController {
         reloadData()
     }
 
-    public func reloadContentFromStackViewRow() {
-        
+    public func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+
     }
 
     private func reloadData() {

ScrollStackControllerDemo/Child View Controllers/GalleryVC.swift

@@ -43,8 +43,8 @@ public class NotesVC: UIViewController, ScrollStackContainableController {
         super.updateViewConstraints()
      }
 
-    public func reloadContentFromStackViewRow() {
-        
+    public func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+
     }
 
     public override func viewDidLoad() {

ScrollStackControllerDemo/Child View Controllers/NotesVC.swift

@@ -65,8 +65,8 @@ public class PricingVC: UIViewController, ScrollStackContainableController {
         viewDidLayoutSubviews()
     }
 
-    public func reloadContentFromStackViewRow() {
-        
+    public func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+
     }
 
     @IBAction public func addFee() {

ScrollStackControllerDemo/Child View Controllers/PricingVC.swift

@@ -52,8 +52,8 @@ public class TagsVC: UIViewController, ScrollStackContainableController {
         return (isExpanded == false ? .fixed(170) : .fixed(170 + collectionView.contentSize.height + 20))
     }
 
-    public func reloadContentFromStackViewRow() {
-        
+    public func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+
     }
 
     public override func viewDidLoad() {

ScrollStackControllerDemo/Child View Controllers/TagsVC.swift

@@ -23,8 +23,8 @@ public class WelcomeVC: UIViewController, ScrollStackContainableController {
         return .fitLayoutForAxis
     }
 
-    public func reloadContentFromStackViewRow() {
-        
+    public func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool) {
+
     }
 
 }

ScrollStackControllerDemo/Child View Controllers/WelcomeVC.swift

@@ -72,6 +72,25 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         } as! [ScrollStackRow]
     }
 
+    /// Return all visible (partially or enterly) rows.
+    public var visibleRows: [ScrollStackRow]? {
+        return rows.enumerated().compactMap { (idx, item) in
+            return (isRowVisible(index: idx).isVisible ? item : nil)
+        }
+    }
+    
+    /// Return only entirly visible rows.
+    public var enterlyVisibleRows: [ScrollStackRow]? {
+        return rows.enumerated().compactMap { (idx, item) in
+            return (isRowVisible(index: idx) == .entire ? item : nil)
+        }
+    }
+    
+    /// Return `true` if no rows are into the stack.
+    public var isEmpty: Bool {
+        return rows.isEmpty
+    }
+    
     /// Get the first row of the stack, if any.
     open var firstRow: ScrollStackRow? {
         return rows.first
@@ -583,7 +602,7 @@ open class ScrollStack: UIScrollView, UIScrollViewDelegate {
         }
 
         rows.forEach {
-            $0.askForCutomizedSizeOfContentView()
+            $0.askForCutomizedSizeOfContentView(animated: animated)
         }
 
         UIView.execute(animated: animated, {

Sources/ScrollStackController/ScrollStack.swift

@@ -176,7 +176,7 @@ open class ScrollStackRow: UIView, UIGestureRecognizerDelegate {
         addSubview(contentView)
         addSubview(separatorView)
 
-        askForCutomizedSizeOfContentView()
+        askForCutomizedSizeOfContentView(animated: false)
 
         didUpdateContentViewContraints()
         didUpdateSeparatorViewContraintsIfNeeded()
@@ -247,7 +247,7 @@ open class ScrollStackRow: UIView, UIGestureRecognizerDelegate {
 
     // MARK: - Sizing the Controller
 
-    internal func askForCutomizedSizeOfContentView() {
+    internal func askForCutomizedSizeOfContentView(animated: Bool) {
         guard let customizableController = controller as? ScrollStackContainableController else {
             return // ignore, it's not implemented, use autolayout.
         }
@@ -264,6 +264,8 @@ open class ScrollStackRow: UIView, UIGestureRecognizerDelegate {
         case .fitLayoutForAxis:
             setupRowSizeToFitLayout()
         }
+        
+        customizableController.reloadContentFromStackView(stackView: stackView!, row: self, animated: animated)
     }
 
     private func setupRowToFixedValue(_ value: CGFloat) {

Sources/ScrollStackController/ScrollStackRow.swift

@@ -52,7 +52,7 @@ public protocol ScrollStackContainableController: UIViewController {
     func scrollStackRowSizeForAxis(_ axis: NSLayoutConstraint.Axis, row: ScrollStackRow, in stackView: ScrollStack) -> ScrollStack.ControllerSize?
 
     /// Method is called when you call a `reloadRow` function on a row where this controller is contained in.
-    func reloadContentFromStackViewRow()
+    func reloadContentFromStackView(stackView: ScrollStack, row: ScrollStackRow, animated: Bool)
 
 }