Merge pull request #83 from componentskit/improve-button

mikhailChelbaev · web-flow · commit 183b632f19fb · 2025-04-08T16:49:01.000+02:00
improve button
diff --git a/Examples/DemosApp/DemosApp/ComponentsPreview/PreviewPages/ButtonPreview.swift b/Examples/DemosApp/DemosApp/ComponentsPreview/PreviewPages/ButtonPreview.swift
@@ -6,7 +6,7 @@ struct ButtonPreview: View {
   @State private var model = ButtonVM {
     $0.title = "Button"
   }
-
+  
   var body: some View {
     VStack {
       PreviewWrapper(title: "UIKit") {
@@ -19,12 +19,33 @@ struct ButtonPreview: View {
       Form {
         AnimationScalePicker(selection: self.$model.animationScale)
         ComponentOptionalColorPicker(selection: self.$model.color)
+        Picker("Content Spacing", selection: self.$model.contentSpacing) {
+          Text("4").tag(CGFloat(4))
+          Text("8").tag(CGFloat(8))
+          Text("12").tag(CGFloat(12))
+        }
         ComponentRadiusPicker(selection: self.$model.cornerRadius) {
           Text("Custom: 20px").tag(ComponentRadius.custom(20))
         }
-        ButtonFontPicker(selection: self.$model.font)
         Toggle("Enabled", isOn: self.$model.isEnabled)
+        ButtonFontPicker(selection: self.$model.font)
         Toggle("Full Width", isOn: self.$model.isFullWidth)
+        Picker("Image Location", selection: self.$model.imageLocation) {
+          Text("Leading").tag(ButtonVM.ImageLocation.leading)
+          Text("Trailing").tag(ButtonVM.ImageLocation.trailing)
+        }
+        Picker("Image Source", selection: self.$model.imageSrc) {
+          Text("SF Symbol").tag(ButtonVM.ImageSource.sfSymbol("camera.fill"))
+          Text("Local").tag(ButtonVM.ImageSource.local("avatar_placeholder"))
+          Text("None").tag(Optional<ButtonVM.ImageSource>.none)
+        }
+        Toggle("Loading", isOn: self.$model.isLoading)
+        Toggle("Show Title", isOn: Binding<Bool>(
+          get: { !self.model.title.isEmpty },
+          set: { newValue in
+            self.model.title = newValue ? "Button" : ""
+          }
+        ))
         SizePicker(selection: self.$model.size)
         Picker("Style", selection: self.$model.style) {
           Text("Filled").tag(ButtonStyle.filled)
diff --git a/Sources/ComponentsKit/Components/Button/Models/ButtonImageLocation.swift b/Sources/ComponentsKit/Components/Button/Models/ButtonImageLocation.swift
@@ -0,0 +1,11 @@
+import Foundation
+
+/// Specifies the position of the image relative to the button's title.
+extension ButtonVM {
+  public enum ImageLocation {
+    /// The image is displayed before the title.
+    case leading
+    /// The image is displayed after the title.
+    case trailing
+  }
+}
diff --git a/Sources/ComponentsKit/Components/Button/Models/ButtonImageSource.swift b/Sources/ComponentsKit/Components/Button/Models/ButtonImageSource.swift
@@ -0,0 +1,18 @@
+import Foundation
+
+/// Defines the image source options for a button.
+extension ButtonVM {
+  public enum ImageSource: Hashable {
+    /// An image loaded from a system SF Symbol.
+    ///
+    /// - Parameter name: The name of the SF Symbol.
+    case sfSymbol(String)
+
+    /// An image loaded from a local asset.
+    ///
+    /// - Parameters:
+    ///   - name: The name of the local image asset.
+    ///   - bundle: The bundle containing the image resource. Defaults to `nil` to use the main bundle.
+    case local(String, bundle: Bundle? = nil)
+  }
+}
diff --git a/Sources/ComponentsKit/Components/Button/Models/ButtonVM.swift b/Sources/ComponentsKit/Components/Button/Models/ButtonVM.swift
@@ -2,9 +2,6 @@ import UIKit
 
 /// A model that defines the appearance properties for a button component.
 public struct ButtonVM: ComponentVM {
-  /// The text displayed on the button.
-  public var title: String = ""
-
   /// The scaling factor for the button's press animation, with a value between 0 and 1.
   ///
   /// Defaults to `.medium`.
@@ -13,6 +10,11 @@ public struct ButtonVM: ComponentVM {
   /// The color of the button.
   public var color: ComponentColor?
 
+  /// The spacing between the button's title and its image or loading indicator.
+  ///
+  /// Defaults to `8.0`.
+  public var contentSpacing: CGFloat = 8.0
+
   /// The corner radius of the button.
   ///
   /// Defaults to `.medium`.
@@ -23,6 +25,14 @@ public struct ButtonVM: ComponentVM {
   /// If not provided, the font is automatically calculated based on the button's size.
   public var font: UniversalFont?
 
+  /// The position of the image relative to the button's title.
+  ///
+  /// Defaults to `.leading`.
+  public var imageLocation: ImageLocation = .leading
+
+  /// The source of the image to be displayed.
+  public var imageSrc: ImageSource?
+
   /// A Boolean value indicating whether the button is enabled or disabled.
   ///
   /// Defaults to `true`.
@@ -33,6 +43,16 @@ public struct ButtonVM: ComponentVM {
   /// Defaults to `false`.
   public var isFullWidth: Bool = false
 
+  /// A Boolean value indicating whether the button is currently in a loading state.
+  ///
+  /// Defaults to `false`.
+  public var isLoading: Bool = false
+
+  /// The loading VM used for the loading indicator.
+  ///
+  /// If not provided, a default loading view model is used.
+  public var loadingVM: LoadingVM?
+
   /// The predefined size of the button.
   ///
   /// Defaults to `.medium`.
@@ -43,21 +63,36 @@ public struct ButtonVM: ComponentVM {
   /// Defaults to `.filled`.
   public var style: ButtonStyle = .filled
 
+  /// The text displayed on the button.
+  public var title: String = ""
+
   /// Initializes a new instance of `ButtonVM` with default values.
   public init() {}
 }
 
 // MARK: Shared Helpers
 
 extension ButtonVM {
+  var isInteractive: Bool {
+    self.isEnabled && !self.isLoading
+  }
+  var preferredLoadingVM: LoadingVM {
+    return self.loadingVM ?? .init {
+      $0.color = .init(
+        main: foregroundColor,
+        contrast: self.color?.main ?? .background
+      )
+      $0.size = .small
+    }
+  }
   var backgroundColor: UniversalColor? {
     switch self.style {
     case .filled:
       let color = self.color?.main ?? .content2
-      return color.enabled(self.isEnabled)
+      return color.enabled(self.isInteractive)
     case .light:
       let color = self.color?.background ?? .content1
-      return color.enabled(self.isEnabled)
+      return color.enabled(self.isInteractive)
     case .plain, .bordered:
       return nil
     }
@@ -69,7 +104,7 @@ extension ButtonVM {
     case .plain, .light, .bordered:
       self.color?.main ?? .foreground
     }
-    return color.enabled(self.isEnabled)
+    return color.enabled(self.isInteractive)
   }
   var borderWidth: CGFloat {
     switch self.style {
@@ -85,7 +120,7 @@ extension ButtonVM {
       return nil
     case .bordered:
       if let color {
-        return color.main.enabled(self.isEnabled)
+        return color.main.enabled(self.isInteractive)
       } else {
         return .divider
       }
@@ -112,6 +147,13 @@ extension ButtonVM {
     case .large: 52
     }
   }
+  var imageSide: CGFloat {
+    switch self.size {
+    case .small: 20
+    case .medium: 24
+    case .large: 28
+    }
+  }
   var horizontalPadding: CGFloat {
     return switch self.size {
     case .small: 16
@@ -121,6 +163,21 @@ extension ButtonVM {
   }
 }
 
+extension ButtonVM {
+  var image: UIImage? {
+    guard let imageSrc else { return nil }
+    switch imageSrc {
+    case .sfSymbol(let name):
+      return UIImage(systemName: name)?.withTintColor(
+        self.foregroundColor.uiColor,
+        renderingMode: .alwaysOriginal
+      )
+    case .local(let name, let bundle):
+      return UIImage(named: name, in: bundle, compatibleWith: nil)
+    }
+  }
+}
+
 // MARK: UIKit Helpers
 
 extension ButtonVM {
@@ -141,10 +198,23 @@ extension ButtonVM {
 
     return .init(width: width, height: self.height)
   }
-  func shouldUpdateSize(_ oldModel: Self?) -> Bool {
-    return self.size != oldModel?.size
-    || self.font != oldModel?.font
-    || self.isFullWidth != oldModel?.isFullWidth
+  func shouldUpdateImagePosition(_ oldModel: Self?) -> Bool {
+    guard let oldModel else { return true }
+    return self.imageLocation != oldModel.imageLocation
+  }
+  func shouldUpdateImageSize(_ oldModel: Self?) -> Bool {
+    guard let oldModel else { return true }
+    return self.imageSide != oldModel.imageSide
+  }
+  func shouldRecalculateSize(_ oldModel: Self?) -> Bool {
+    guard let oldModel else { return true }
+    return self.size != oldModel.size
+    || self.font != oldModel.font
+    || self.isFullWidth != oldModel.isFullWidth
+    || self.isLoading != oldModel.isLoading
+    || self.imageSrc != oldModel.imageSrc
+    || self.contentSpacing != oldModel.contentSpacing
+    || self.title != oldModel.title
   }
 }
 
diff --git a/Sources/ComponentsKit/Components/Button/SUButton.swift b/Sources/ComponentsKit/Components/Button/SUButton.swift
@@ -29,26 +29,78 @@ public struct SUButton: View {
   // MARK: Body
 
   public var body: some View {
-    Button(self.model.title, action: self.action)
-      .buttonStyle(CustomButtonStyle(model: self.model))
-      .simultaneousGesture(DragGesture(minimumDistance: 0.0)
-        .onChanged { _ in
-          self.isPressed = true
-        }
-        .onEnded { _ in
-          self.isPressed = false
-        }
-      )
-      .disabled(!self.model.isEnabled)
-      .scaleEffect(
-        self.isPressed ? self.model.animationScale.value : 1,
-        anchor: .center
-      )
+    Button(action: self.action) {
+      HStack(spacing: self.model.contentSpacing) {
+        self.content
+      }
+    }
+    .buttonStyle(CustomButtonStyle(model: self.model))
+    .simultaneousGesture(DragGesture(minimumDistance: 0.0)
+      .onChanged { _ in
+        self.isPressed = true
+      }
+      .onEnded { _ in
+        self.isPressed = false
+      }
+    )
+    .disabled(!self.model.isInteractive)
+    .scaleEffect(
+      self.isPressed ? self.model.animationScale.value : 1,
+      anchor: .center
+    )
+  }
+
+  @ViewBuilder
+  private var content: some View {
+    switch (self.model.isLoading, self.model.image, self.model.imageLocation) {
+    case (true, _, _) where self.model.title.isEmpty:
+      SULoading(model: self.model.preferredLoadingVM)
+    case (true, _, _):
+      SULoading(model: self.model.preferredLoadingVM)
+      Text(self.model.title)
+    case (false, let uiImage?, .leading) where self.model.title.isEmpty:
+      ButtonImageView(image: uiImage)
+        .frame(width: self.model.imageSide, height: self.model.imageSide)
+    case (false, let uiImage?, .leading):
+      ButtonImageView(image: uiImage)
+        .frame(width: self.model.imageSide, height: self.model.imageSide)
+      Text(self.model.title)
+    case (false, let uiImage?, .trailing) where self.model.title.isEmpty:
+      ButtonImageView(image: uiImage)
+        .frame(width: self.model.imageSide, height: self.model.imageSide)
+    case (false, let uiImage?, .trailing):
+      Text(self.model.title)
+      ButtonImageView(image: uiImage)
+        .frame(width: self.model.imageSide, height: self.model.imageSide)
+    case (false, _, _):
+      Text(self.model.title)
+    }
   }
 }
 
 // MARK: - Helpers
 
+private struct ButtonImageView: UIViewRepresentable {
+  class InternalImageView: UIImageView {
+    override var intrinsicContentSize: CGSize {
+      return .zero
+    }
+  }
+
+  let image: UIImage
+
+  func makeUIView(context: Context) -> UIImageView {
+    let imageView = InternalImageView()
+    imageView.image = self.image
+    imageView.contentMode = .scaleAspectFit
+    return imageView
+  }
+
+  func updateUIView(_ imageView: UIImageView, context: Context) {
+    imageView.image = self.image
+  }
+}
+
 private struct CustomButtonStyle: SwiftUI.ButtonStyle {
   let model: ButtonVM
 
diff --git a/Sources/ComponentsKit/Components/Button/UKButton.swift b/Sources/ComponentsKit/Components/Button/UKButton.swift
