Code cleanup, configuration, and readme.

Author: Trent Guillory

ActionButtonDemo/Sources/AppDelegate.swift

@@ -1,36 +1,34 @@
-//
-//  AppDelegate.swift
-//  ActionButtonDemo
-//
-//  Created by Trent Guillory on 9/10/21.
-//
-
 import UIKit
 
 @main
 class AppDelegate: UIResponder, UIApplicationDelegate {
 
-
-
-    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+    func application(
+        _ application: UIApplication,
+        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)
+        -> Bool {
         // Override point for customization after application launch.
         return true
     }
 
     // MARK: UISceneSession Lifecycle
 
-    func application(_ application: UIApplication, configurationForConnecting connectingSceneSession: UISceneSession, options: UIScene.ConnectionOptions) -> UISceneConfiguration {
+    func application(
+        _ application: UIApplication,
+        configurationForConnecting connectingSceneSession: UISceneSession,
+        options: UIScene.ConnectionOptions) -> UISceneConfiguration {
         // Called when a new scene session is being created.
         // Use this method to select a configuration to create the new scene with.
-        return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
+        return UISceneConfiguration(
+            name: "Default Configuration",
+            sessionRole: connectingSceneSession.role)
     }
 
-    func application(_ application: UIApplication, didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
+    func application(
+        _ application: UIApplication,
+        didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
         // Called when the user discards a scene session.
         // If any sessions were discarded while the application was not running, this will be called shortly after application:didFinishLaunchingWithOptions.
         // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
     }
-
-
 }
-

ActionButtonDemo/Sources/ContentView.swift

@@ -4,28 +4,33 @@ import SwiftUI
 // MARK: - ContentView
 
 struct ContentView: View {
-    
-    @State var actionButtonState: ActionButtonState = .enabled(.init(title: "Load Something", systemImage: "bolt"))
-    
+
+    // MARK: Internal
+
+    @State var actionButtonState: ActionButtonState =
+        .enabled(.init(title: "Load Something", systemImage: "bolt"))
+
     var body: some View {
 
         VStack {
 
             Text("Just a little button.")
             ActionButton(state: $actionButtonState, onTap: {
-        
+
                 loadSomething()
-            })
-            .frame(maxWidth: 250)
+            }, backgroundColor: .red)
+                .frame(maxWidth: 250)
         }
     }
-    
+
+    // MARK: Private
+
     private func loadSomething() {
-        
+
         actionButtonState = .loading(.init(title: "Loading", systemImage: "bolt"))
-        
+
         DispatchQueue.main.asyncAfter(deadline: .now() + 1.25) {
-            
+
             actionButtonState = .disabled(.init(title: "Loaded", systemImage: "checkmark"))
         }
     }

ActionButtonDemo/Sources/SceneDelegate.swift

@@ -1,19 +1,14 @@
-//
-//  SceneDelegate.swift
-//  ActionButtonDemo
-//
-//  Created by Trent Guillory on 9/10/21.
-//
-
-import UIKit
 import SwiftUI
+import UIKit
 
 class SceneDelegate: UIResponder, UIWindowSceneDelegate {
 
     var window: UIWindow?
 
-
-    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
+    func scene(
+        _ scene: UIScene,
+        willConnectTo session: UISceneSession,
+        options connectionOptions: UIScene.ConnectionOptions) {
         // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
         // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
         // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead).
@@ -57,7 +52,4 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
         // Use this method to save data, release shared resources, and store enough scene-specific state information
         // to restore the scene back to its current state.
     }
-
-
 }
-

README.md

@@ -1,3 +1,54 @@
 # ActionButton
 
-A description of this package.
+`Button` alternative providing built-in states for `.enabled`, `.disabled`, and `.loading`.
+
+## How to Use
+
+1. Import `ActionButton`
+2. Create a state or binding variable of type `ActionState`. This will drive the content of `ActionButton`
+3. Add `ActionButton` to your view and configure it. 
+
+Below is a an example of the code used in the video demo above. So how do we animate between states?
+
+```swift
+@State var actionButtonState: ActionButtonState =
+    .enabled(.init(title: "Load Something", systemImage: "bolt"))
+
+var body: some View {
+
+    VStack {
+
+        Text("Just a little button.")
+        ActionButton(state: $actionButtonState, onTap: {
+
+            loadSomething()
+        }, backgroundColor: .red)
+            .frame(maxWidth: 250)
+    }
+}
+``` 
+**Animating between states.**
+
+Animating between states is handled automatically. Take a look at our `loadSomething()` function.
+
+```swift
+private func loadSomething() {
+
+    actionButtonState = .loading(.init(title: "Loading", systemImage: "bolt"))
+
+    DispatchQueue.main.asyncAfter(deadline: .now() + 1.25) {
+
+        actionButtonState = .disabled(.init(title: "Loaded", systemImage: "checkmark"))
+    }
+}
+```
+In our example, we use a delay to simply change the state variable `actionButtonState`. The view responds accordingly. k
+
+## Configuration
+
+`ActionButton` takes in a handful of parameters in its initialization. 
+
+- `state`: `ActionButtonState` - This is an enum (enabled, loading, disabled) with an associated value of type `ActionButtonModel` which allows you to set the SFSymbol and text of the button. 
+- `onTap`: `(() -> Void)` - A callback to handle any taps. This is required since `ActionButton` handles its own tap animation. Your own `onTapGesture` won't work here.
+- `backgroundColor`: `Color` - the background color for the button during its `enabled` state.
+- `foregroundColor`: `Color` - the foreground color for the button during all states.

Sources/ActionButton.swift

@@ -8,9 +8,15 @@ public struct ActionButton: View {
 
     // MARK: Lifecycle
 
-    public init(state: Binding<ActionButtonState>, onTap: @escaping TapHandler) {
+    public init(
+        state: Binding<ActionButtonState>,
+        onTap: @escaping TapHandler,
+        backgroundColor: Color,
+        foregroundColor: Color = .white) {
 
         _state = state
+        self.foregroundColor = foregroundColor
+        self.backgroundColor = backgroundColor
         tapHandler = onTap
     }
 
@@ -37,13 +43,13 @@ public struct ActionButton: View {
                 Text(state.title)
             }
             .font(.system(size: 14, weight: .medium))
-            .foregroundColor(.white)
+            .foregroundColor(foregroundColor)
 
             Spacer()
         }
         .frame(height: 22)
         .padding(8)
-        .background(backgroundColor)
+        .background(background)
         .animation(.fastFade, value: state.enabled)
         .cornerRadius(8)
         .scaleEffect(scale)
@@ -62,28 +68,35 @@ public struct ActionButton: View {
             .onEnded { _ in
 
                 self.isPressing = false
-                tapHandler()
+
+                switch state {
+
+                case .enabled: tapHandler()
+                default: break
+                }
             }
     }
-    
+
     var scale: CGFloat {
-        
+
         switch state {
-        
+
         case .enabled: return isPressing ? 0.95 : 1
         default: return 1
         }
     }
 
-    var backgroundColor: Color {
+    var background: Color {
 
-        state.enabled ? Color.red : Color.gray
+        state.enabled ? backgroundColor : Color.gray
     }
 
     // MARK: Private
 
     @State private var isPressing = false
     private var tapHandler: TapHandler
+    private var backgroundColor: Color
+    private var foregroundColor: Color
 }
 
 // MARK: - ActionButton_Previews
@@ -94,6 +107,6 @@ struct ActionButton_Previews: PreviewProvider {
 
         ActionButton(state: .constant(.enabled(.init(
             title: "New Draft",
-            systemImage: "plus.circle"))), onTap: {})
+            systemImage: "plus.circle"))), onTap: {}, backgroundColor: .red)
     }
 }