Merge pull request #783 from hyperoslo/optimize/component-layout-method

Add needsLayout to setup() & layout() methods on Component

Sources/Shared/Classes/SpotsControllerManager.swift

@@ -719,7 +719,7 @@ public class SpotsControllerManager {
     }
 
     let tempComponent = Component(model: model, configuration: controller.configuration)
-    tempComponent.setup(with: setupSize)
+    tempComponent.setup(with: setupSize, needsLayout: false)
     tempComponent.model.size = CGSize(
       width: controller.view.frame.width,
       height: ceil(tempComponent.view.frame.height))

Sources/iOS/Classes/Component.swift

@@ -169,7 +169,7 @@ public class Component: NSObject, ComponentHorizontallyScrollable {
   /// Setup up the component with a given size, this is usually the parent size when used in a controller context.
   ///
   /// - Parameter size: A `CGSize` that is used to set the frame of the user interface.
-  public func setup(with size: CGSize) {
+  public func setup(with size: CGSize, needsLayout: Bool = true) {
     view.frame.size = size
 
     setupFooter(with: configuration)
@@ -181,7 +181,7 @@ public class Component: NSObject, ComponentHorizontallyScrollable {
       setupCollectionView(collectionView, with: size)
     }
 
-    layout(with: size)
+    layout(with: size, needsLayout: needsLayout)
     configurePageControl()
     Component.configure?(self)
 
@@ -194,15 +194,21 @@ public class Component: NSObject, ComponentHorizontallyScrollable {
   /// Configure the view frame with a given size.
   ///
   /// - Parameter size: A `CGSize` used to set a new size to the user interface.
-  public func layout(with size: CGSize) {
+  public func layout(with size: CGSize, needsLayout: Bool = true) {
     if let tableView = self.tableView {
       layoutTableView(tableView, with: size)
     } else if let collectionView = self.collectionView {
       layoutCollectionView(collectionView, with: size)
     }
 
     layoutHeaderFooterViews(size)
+
+    guard needsLayout else {
+      return
+    }
+
     view.setNeedsLayout()
+
     // Only call `layoutIfNeeded` if the `Component` is not a part of a `SpotsController`.
     if let spotsScrollView = (focusDelegate as? SpotsController)?.scrollView {
       let isVisibleOnScreen = view.frame.intersects(.init(origin: spotsScrollView.contentOffset,
@@ -357,4 +363,3 @@ public class Component: NSObject, ComponentHorizontallyScrollable {
     view.superview?.layoutIfNeeded()
   }
 }
-

Sources/macOS/Classes/Component.swift

@@ -207,7 +207,7 @@ import Cocoa
   /// Setup up the component with a given size, this is usually the parent size when used in a controller context.
   ///
   /// - Parameter size: A `CGSize` that is used to set the frame of the user interface.
-  public func setup(with size: CGSize) {
+  public func setup(with size: CGSize, needsLayout: Bool = false) {
     scrollView.frame.size = size
 
     setupHeader(with: configuration)
@@ -221,7 +221,7 @@ import Cocoa
       setupCollectionView(collectionView, with: size)
     }
 
-    layout(with: size, animated: false)
+    layout(with: size, needsLayout: needsLayout, animated: false)
     Component.configure?(self)
   }
 
@@ -230,7 +230,7 @@ import Cocoa
   /// - Parameter size: A `CGSize` used to set a new size to the user interface.
   /// - Parameter animated: Determines if the `Component` should perform animation when
   ///                       applying its new size.
-  public func layout(with size: CGSize, animated: Bool = true) {
+  public func layout(with size: CGSize, needsLayout: Bool = false, animated: Bool = true) {
     userInterface?.layoutIfNeeded()
 
     if let tableView = self.tableView {
@@ -254,6 +254,13 @@ import Cocoa
         view.superview?.layoutSubviews()
       }
     }
+
+    guard needsLayout else {
+      return
+    }
+
+    view.needsLayout = true
+    view.layoutIfNeeded()
   }
 
   /// Setup a collection view with a specific size.