Add isIncludedInPinLayout property to Layoutable

Author: stleamist

Sources/Extensions/CALayer+PinLayout.swift

@@ -20,6 +20,10 @@
 import QuartzCore
 
 extension CALayer: Layoutable {
+    private struct pinlayoutAssociatedKeys {
+        static var pinlayoutIsIncludedInPinLayoutSizeCalculation = UnsafeMutablePointer<Int8>.allocate(capacity: 1)
+    }
+
     public typealias PinView = CALayer
 
     public var superview: CALayer? {
@@ -38,6 +42,15 @@ extension CALayer: Layoutable {
         return PinLayout(view: self, keepTransform: false)
     }
 
+    public var isIncludedInPinLayoutSizeCalculation: Bool {
+        get {
+            return objc_getAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation) as? Bool ?? true
+        }
+        set {
+            objc_setAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation, newValue, objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
+        }
+    }
+
     public func getRect(keepTransform: Bool) -> CGRect {
         if keepTransform {
             /*

Sources/Extensions/NSView+PinLayout.swift

@@ -23,6 +23,10 @@ import Foundation
 import AppKit
 
 extension NSView: Layoutable {
+    private struct pinlayoutAssociatedKeys {
+        static var pinlayoutIsIncludedInPinLayoutSizeCalculation = UnsafeMutablePointer<Int8>.allocate(capacity: 1)
+    }
+  
     public typealias PinView = NSView
 
     public var pin: PinLayout<NSView> {
@@ -37,6 +41,15 @@ extension NSView: Layoutable {
         return PinLayoutObjCImpl(view: self, keepTransform: true)
     }
 
+    public var isIncludedInPinLayoutSizeCalculation: Bool {
+        get {
+            return objc_getAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation) as? Bool ?? true
+        }
+        set {
+            objc_setAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation, newValue, objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
+        }
+    }
+
     public func getRect(keepTransform: Bool) -> CGRect {
         if let superview = superview, !superview.isFlipped {
             var flippedRect = frame

Sources/Extensions/UIView+PinLayout.swift

@@ -37,6 +37,15 @@ extension UIView: Layoutable, SizeCalculable {
         return PinLayoutObjCImpl(view: self, keepTransform: true)
     }
 
+    public var isIncludedInPinLayoutSizeCalculation: Bool {
+        get {
+            return objc_getAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation) as? Bool ?? true
+        }
+        set {
+            objc_setAssociatedObject(self, &pinlayoutAssociatedKeys.pinlayoutIsIncludedInPinLayoutSizeCalculation, newValue, objc_AssociationPolicy.OBJC_ASSOCIATION_RETAIN_NONATOMIC)
+        }
+    }
+
     public func getRect(keepTransform: Bool) -> CGRect {
         guard !Pin.autoSizingInProgress || autoSizingRect == nil else { return autoSizingRect ?? CGRect.zero }
 
@@ -95,6 +104,7 @@ extension UIView: Layoutable, SizeCalculable {
 
 extension UIView: AutoSizeCalculable {
     private struct pinlayoutAssociatedKeys {
+        static var pinlayoutIsIncludedInPinLayoutSizeCalculation = UnsafeMutablePointer<Int8>.allocate(capacity: 1)
         static var pinlayoutAutoSizingRect = UnsafeMutablePointer<Int8>.allocate(capacity: 1)
         static var pinlayoutAutoSizingRectWithMargins = UnsafeMutablePointer<Int8>.allocate(capacity: 1)
     }

Sources/Layoutable.swift

@@ -29,10 +29,23 @@ public protocol Layoutable: AnyObject, Equatable, CustomDebugStringConvertible {
     var superview: PinView? { get }
     var subviews: [PinView] { get }
 
+    /// A Boolean value that determines whether the view is included in the PinLayout's size calculation.
+    ///
+    /// An excluded view does not take up space in the layout
+    /// when using `wrapContent(_:padding:_:)` or `autoSizeThatFits(_:layoutClosure:)`.
+    /// The default value is `true`.
+    var isIncludedInPinLayoutSizeCalculation: Bool { get set }
+
     func getRect(keepTransform: Bool) -> CGRect
     func setRect(_ rect: CGRect, keepTransform: Bool)
 
     func convert(_ point: CGPoint, to view: PinView?) -> CGPoint
 
     func isLTR() -> Bool
 }
+
+extension Layoutable {
+    var subviewsIncludedInSizeCalculation: [PinView] {
+        return subviews.filter(\.isIncludedInPinLayoutSizeCalculation)
+    }
+}