Merge branch 'modal-uikit' into modal-swiftui

Author: mikhailChelbaev

Sources/ComponentsKit/Modal/UIKit/Helpers/ContentSizedScrollView.swift

@@ -1,13 +1,15 @@
 import UIKit
 
-public final class ContentSizedScrollView: UIScrollView {
-  public override var contentSize: CGSize {
+/// A custom `UIScrollView` subclass that automatically adjusts its intrinsic content size
+/// based on its content size, ensuring it fits its content vertically.
+final class ContentSizedScrollView: UIScrollView {
+  override var contentSize: CGSize {
     didSet {
       self.invalidateIntrinsicContentSize()
     }
   }
 
-  public override var intrinsicContentSize: CGSize {
+  override var intrinsicContentSize: CGSize {
     self.layoutIfNeeded()
     return CGSize(
       width: UIView.noIntrinsicMetric,

Sources/ComponentsKit/Modal/UIKit/UKBottomModalController.swift

@@ -1,6 +1,16 @@
 import UIKit
 
+/// A bottom-aligned modal controller.
 public class UKBottomModalController: UKModalController<BottomModalVM> {
+  // MARK: - Initialization
+
+  /// Initializer.
+  ///
+  /// - Parameters:
+  ///   - model: A model that defines the appearance properties.
+  ///   - header: An optional content block for the modal's header.
+  ///   - body: The main content block for the modal.
+  ///   - footer: An optional content block for the modal's footer.
   public override init(
     model: BottomModalVM = .init(),
     header: Content? = nil,
@@ -14,6 +24,8 @@ public class UKBottomModalController: UKModalController<BottomModalVM> {
     fatalError("init(coder:) has not been implemented")
   }
 
+  // MARK: - Lifecycle
+
   public override func viewWillAppear(_ animated: Bool) {
     super.viewWillAppear(animated)
 
@@ -30,6 +42,8 @@ public class UKBottomModalController: UKModalController<BottomModalVM> {
     }
   }
 
+  // MARK: - Setup
+
   public override func setup() {
     super.setup()
 
@@ -39,12 +53,16 @@ public class UKBottomModalController: UKModalController<BottomModalVM> {
     ))
   }
 
+  // MARK: - Layout
+
   public override func layout() {
     super.layout()
 
     self.container.bottom(self.model.outerPaddings.bottom, safeArea: true)
   }
 
+  // MARK: - UIViewController Methods
+
   public override func dismiss(
     animated flag: Bool,
     completion: (() -> Void)? = nil

Sources/ComponentsKit/Modal/UIKit/UKCenterModalController.swift

@@ -1,6 +1,16 @@
 import UIKit
 
+/// A center-aligned modal controller.
 public class UKCenterModalController: UKModalController<CenterModalVM> {
+  // MARK: - Initialization
+
+  /// Initializer.
+  ///
+  /// - Parameters:
+  ///   - model: A model that defines the appearance properties.
+  ///   - header: An optional content block for the modal's header.
+  ///   - body: The main content block for the modal.
+  ///   - footer: An optional content block for the modal's footer.
   public override init(
     model: CenterModalVM = .init(),
     header: Content? = nil,
@@ -14,6 +24,8 @@ public class UKCenterModalController: UKModalController<CenterModalVM> {
     fatalError("init(coder:) has not been implemented")
   }
 
+  // MARK: - Lifecycle
+
   public override func viewWillAppear(_ animated: Bool) {
     super.viewWillAppear(animated)
 
@@ -30,6 +42,8 @@ public class UKCenterModalController: UKModalController<CenterModalVM> {
     }
   }
 
+  // MARK: - Layout
+
   public override func layout() {
     super.layout()
 
@@ -40,6 +54,8 @@ public class UKCenterModalController: UKModalController<CenterModalVM> {
     self.container.centerVertically()
   }
 
+  // MARK: - UIViewController Methods
+
   public override func dismiss(
     animated flag: Bool,
     completion: (() -> Void)? = nil

Sources/ComponentsKit/Modal/UIKit/UKModalController.swift

@@ -1,19 +1,36 @@
 import AutoLayout
 import UIKit
 
+/// A generic class that defines shared behavior for modal controllers.
 open class UKModalController<VM: ModalVM>: UIViewController {
+  // MARK: - Typealiases
+
+  /// A typealias for content providers, which create views for the header, body, or footer.
+  /// The content provider closure receives a dismiss action that can be called to close the modal.
   public typealias Content = (_ dismiss: @escaping (_ animated: Bool) -> Void) -> UIView
 
+  // MARK: - Properties
+
+  /// A model that defines the appearance properties.
   public let model: VM
 
+  /// The optional header view of the modal.
   public var header: UIView?
+  /// The main body view of the modal.
   public var body = UIView()
+  /// The optional footer view of the modal.
   public var footer: UIView?
-  public var container = UIView()
+  /// The container view that holds the modal's content.
+  public let container = UIView()
+  /// The content view inside the container, holding the header, body, and footer.
   public let content = UIView()
-  public let bodyWrapper = ContentSizedScrollView()
+  /// A scrollable wrapper for the body content.
+  public let bodyWrapper: UIScrollView = ContentSizedScrollView()
+  /// The overlay view that appears behind the modal.
   public let overlay: UIView
 
+  // MARK: - Initialization
+
   init(
     model: VM = .init(),
     header: Content? = nil,
@@ -49,6 +66,8 @@ open class UKModalController<VM: ModalVM>: UIViewController {
     fatalError("init(coder:) has not been implemented")
   }
 
+  // MARK: - Lifecycle
+
   open override func viewDidLoad() {
     super.viewDidLoad()
 
@@ -59,6 +78,7 @@ open class UKModalController<VM: ModalVM>: UIViewController {
 
   // MARK: - Setup
 
+  /// Sets up the modal's subviews and gesture recognizers.
   open func setup() {
     self.view.addSubview(self.overlay)
     self.view.addSubview(self.container)
@@ -86,6 +106,7 @@ open class UKModalController<VM: ModalVM>: UIViewController {
 
   // MARK: - Style
 
+  /// Applies styling to the modal's components based on the model.
   open func style() {
     Self.Style.overlay(self.overlay, model: self.model)
     Self.Style.container(self.container, model: self.model)
@@ -95,6 +116,7 @@ open class UKModalController<VM: ModalVM>: UIViewController {
 
   // MARK: - Layout
 
+  /// Configures the layout of the modal's components.
   open func layout() {
     self.overlay.allEdges()
     self.content.allEdges()