add docs for modal vms

Author: mikhailChelbaev

Sources/ComponentsKit/Modal/Models/BottomModalVM.swift

@@ -2,27 +2,57 @@ import Foundation
 
 /// A model that defines the appearance properties for a bottom modal component.
 public struct BottomModalVM: ModalVM {
+  /// The background color of the modal's content area.
   public var backgroundColor: UniversalColor = Palette.Base.secondaryBackground
 
+  /// A Boolean value indicating whether the modal should close when tapping on the overlay.
+  ///
+  /// Defaults to `true`.
   public var closesOnOverlayTap: Bool = true
 
+  /// The padding applied to the modal's content area.
+  ///
+  /// Defaults to a padding value of `16` for all sides.
   public var contentPaddings: Paddings = .init(padding: 16)
 
+  /// The spacing between header, body and footer.
   public var contentSpacing: CGFloat = 16
 
+  /// The corner radius of the modal.
+  ///
+  /// Defaults to `.medium`.
   public var cornerRadius: ModalRadius = .medium
 
+  /// A Boolean value indicating whether the modal should hide when it is swiped down.
+  ///
+  /// Defaults to `true`.
+  public var hidesOnSwap: Bool = true
+
+  /// A Boolean value indicating whether the modal is draggable.
+  ///
+  /// If `true`, the modal can be dragged vertically. Defaults to `true`.
+  public var isDraggable: Bool = true
+
+  /// The style of the overlay displayed behind the modal.
+  ///
+  /// Defaults to `.dimmed`.
   public var overlayStyle: ModalOverlayStyle = .dimmed
 
+  /// The padding applied outside the modal's content area, creating space between the modal and the screen edges.
+  ///
+  /// Defaults to a padding value of `20` for all sides.
   public var outerPaddings: Paddings = .init(padding: 20)
 
+  /// The predefined maximum size of the modal.
+  ///
+  /// Defaults to `.medium`.
   public var size: ModalSize = .medium
 
+  /// The transition duration of the modal's appearance and dismissal animations.
+  ///
+  /// Defaults to `.fast`.
   public var transition: ModalTransition = .fast
 
-  public var isDraggable: Bool = true
-  public var hidesOnSwap: Bool = true
-
-  /// Initializes a new instance of `ModalVM` with default values.
+  /// Initializes a new instance of `BottomModalVM` with default values.
   public init() {}
 }

Sources/ComponentsKit/Modal/Models/CenterModalVM.swift

@@ -2,24 +2,47 @@ import Foundation
 
 /// A model that defines the appearance properties for a center modal component.
 public struct CenterModalVM: ModalVM {
+  /// The background color of the modal's content area.
   public var backgroundColor: UniversalColor = Palette.Base.secondaryBackground
 
+  /// A Boolean value indicating whether the modal should close when tapping on the overlay.
+  ///
+  /// Defaults to `true`.
   public var closesOnOverlayTap: Bool = true
 
+  /// The padding applied to the modal's content area.
+  ///
+  /// Defaults to a padding value of `16` for all sides.
   public var contentPaddings: Paddings = .init(padding: 16)
 
+  /// The spacing between header, body and footer.
   public var contentSpacing: CGFloat = 16
 
+  /// The corner radius of the modal.
+  ///
+  /// Defaults to `.medium`.
   public var cornerRadius: ModalRadius = .medium
 
+  /// The style of the overlay displayed behind the modal.
+  ///
+  /// Defaults to `.dimmed`.
   public var overlayStyle: ModalOverlayStyle = .dimmed
 
+  /// The padding applied outside the modal's content area, creating space between the modal and the screen edges.
+  ///
+  /// Defaults to a padding value of `20` for all sides.
   public var outerPaddings: Paddings = .init(padding: 20)
 
+  /// The predefined maximum size of the modal.
+  ///
+  /// Defaults to `.medium`.
   public var size: ModalSize = .medium
 
+  /// The transition duration of the modal's appearance and dismissal animations.
+  ///
+  /// Defaults to `.fast`.
   public var transition: ModalTransition = .fast
 
-  /// Initializes a new instance of `ModalVM` with default values.
+  /// Initializes a new instance of `BottomModalVM` with default values.
   public init() {}
 }

Sources/ComponentsKit/Modal/Models/ModalVM.swift

@@ -2,13 +2,30 @@ import Foundation
 
 /// A model that defines generic appearance properties that can be in any modal component.
 public protocol ModalVM: ComponentVM {
+  /// The background color of the modal's content area.
   var backgroundColor: UniversalColor { get set }
+
+  /// A Boolean value indicating whether the modal should close when tapping on the overlay.
   var closesOnOverlayTap: Bool { get set }
+
+  /// The padding applied to the modal's content area.
   var contentPaddings: Paddings { get set }
+
+  /// The spacing between header, body and footer.
   var contentSpacing: CGFloat { get set }
+
+  /// The corner radius of the modal.
   var cornerRadius: ModalRadius { get set }
+
+  /// The style of the overlay displayed behind the modal.
   var overlayStyle: ModalOverlayStyle { get set }
+
+  /// The padding applied outside the modal's content area, creating space between the modal and the screen edges.
   var outerPaddings: Paddings { get set }
+
+  /// The predefined maximum size of the modal.
   var size: ModalSize { get set }
+
+  /// The transition duration of the modal's appearance and dismissal animations.
   var transition: ModalTransition { get set }
 }