add docs for ukalert

Author: mikhailChelbaev

Sources/ComponentsKit/Components/Alert/Models/AlertVM.swift

@@ -2,20 +2,28 @@ import Foundation
 
 /// A model that defines the appearance properties for an alert.
 public struct AlertVM: ComponentVM {
+  /// The title of the alert.
   public var title: String?
 
+  /// The message of the alert.
   public var message: String?
 
+  /// The modal that defines the appearance properties for a primary button in the alert.
+  ///
+  /// If it is `nil`, the primary button will not be displayed.
   public var primaryButton: AlertButtonVM?
 
+  /// The modal that defines the appearance properties for a secondary button in the alert.
+  ///
+  /// If it is `nil`, the secondary button will not be displayed.
   public var secondaryButton: AlertButtonVM?
 
   /// The background color of the modal.
   public var backgroundColor: UniversalColor?
 
   /// A Boolean value indicating whether the modal should close when tapping on the overlay.
   ///
-  /// Defaults to `true`.
+  /// Defaults to `false`.
   public var closesOnOverlayTap: Bool = false
 
   /// The padding applied to the modal's content area.

Sources/ComponentsKit/Components/Alert/UKAlertController.swift

@@ -1,17 +1,63 @@
 import UIKit
 
+/// A controller that presents an alert with a title, message, and up to two action buttons.
+///
+/// - Example:
+/// ```swift
+/// let alert = UKAlertController(
+///   model: .init { alertVM in
+///     alertVM.title = "My Alert"
+///     alertVM.message = "This is an alert."
+///     alertVM.primaryButton = .init { buttonVM in
+///       buttonVM.title = "OK"
+///       buttonVM.color = .primary
+///       buttonVM.style = .filled
+///     }
+///     alertVM.secondaryButton = .init { buttonVM in
+///       buttonVM.title = "Cancel"
+///       buttonVM.style = .light
+///     }
+///   }, primaryAction: {
+///     NSLog("Primary button tapped")
+///   }, secondaryAction: {
+///     NSLog("Secondary button tapped")
+///   }
+/// )
+///
+/// vc.present(alert, animated: true)
+/// ```
 public class UKAlertController: UKCenterModalController {
+  // MARK: - Properties
+
+  /// The model that defines the appearance of the alert.
   public let alertVM: AlertVM
 
+  /// The primary action to be executed when the primary button is tapped.
+  public var primaryAction: (() -> Void)?
+  /// The secondary action to be executed when the secondary button is tapped.
+  public var secondaryAction: (() -> Void)?
+
+  // MARK: - Subviews
+
+  /// The label used to display the title of the alert.
   public let titleLabel = UILabel()
+  /// The label used to display the subtitle or message of the alert.
   public let subtitleLabel = UILabel()
+  /// The button representing the primary action in the alert.
   public let primaryButton = UKButton()
+  /// The button representing the secondary action in the alert.
   public let secondaryButton = UKButton()
+  /// A stack view that arranges the primary and secondary buttons.
   public let buttonsStackView = UIStackView()
 
-  public var primaryAction: (() -> Void)?
-  public var secondaryAction: (() -> Void)?
+  // MARK: - Initialization
 
+  /// Initializer.
+  ///
+  /// - Parameters:
+  ///   - model: The `AlertVM` model that defines the appearance and behavior of the alert.
+  ///   - primaryAction: An optional closure executed when the primary button is tapped.
+  ///   - secondaryAction: An optional closure executed when the secondary button is tapped.
   public init(
     model: AlertVM,
     primaryAction: (() -> Void)? = nil,
@@ -29,6 +75,8 @@ public class UKAlertController: UKCenterModalController {
     fatalError("init(coder:) has not been implemented")
   }
 
+  // MARK: - Setup
+
   public override func setup() {
     if self.alertVM.title.isNotNilAndEmpty,
        self.alertVM.message.isNotNilAndEmpty {
@@ -65,6 +113,8 @@ public class UKAlertController: UKCenterModalController {
     super.setup()
   }
 
+  // MARK: - Style
+
   public override func style() {
     super.style()
 
@@ -80,6 +130,8 @@ public class UKAlertController: UKCenterModalController {
     }
   }
 
+  // MARK: - Layout
+
   public override func updateViewConstraints() {
     super.updateViewConstraints()
 
@@ -116,6 +168,8 @@ public class UKAlertController: UKCenterModalController {
   }
 }
 
+// MARK: - Style Helpers
+
 extension UKAlertController {
   fileprivate enum Style {
     static func titleLabel(_ label: UILabel, text: String?) {