Add keyboard shortcut modifier for standard button type

danielsaidi · Jan 20, 2025 · 417bfd1 · 417bfd1
1 parent a9c4746
commit 417bfd1
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 19 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -4,12 +4,13 @@ SwiftUIKit makes its best effort to honor semver, but breaking changes can occur
 
 
 
-## 5.0.4
+## 5.1
 
 ### ✨ Features
 
-* `Button+Standard` has support for a new `.search` type.
-
+* `StandardButtonType` has been promoted to a top-level type.
+* `View` has a new `StandardButtonType`-based `.keyboardShortcut` modifier.
+
 
 
 ## 5.0.3

diff --git a/.../SwiftUIKit/Buttons/Button+Standard.swift → ...iftUIKit/Buttons/StandardButtonType.swift b/.../SwiftUIKit/Buttons/Button+Standard.swift → ...iftUIKit/Buttons/StandardButtonType.swift
@@ -12,7 +12,7 @@ public extension Button {
 
     /// Create a new ``StandardType``-based button.
     init(
-        _ type: StandardType,
+        _ type: ButtonType,
         _ title: LocalizedStringKey? = nil,
         _ icon: Image? = nil,
         bundle: Bundle? = nil,
@@ -25,22 +25,23 @@ public extension Button {
             )
         }
     }
-
-    /// This enum defines standard button types and provides
-    /// standard localized texts and icons.
-    enum StandardType: String, CaseIterable, Identifiable {
-        case add, addFavorite, addToFavorites,
-             cancel, call, copy,
-             delete, deselect, done, 
-             edit, email,
-             ok, 
-             paste,
-             removeFavorite, removeFromFavorites, 
-             search, select, share
-    }
 }
 
-public extension Button.StandardType {
+
+/// This enum defines standard button types and provides
+/// standard localized texts and icons.
+public enum ButtonType: String, CaseIterable, Identifiable {
+    case add, addFavorite, addToFavorites,
+         cancel, call, copy,
+         delete, deselect, done,
+         edit, email,
+         ok,
+         paste,
+         removeFavorite, removeFromFavorites,
+         search, select, share
+}
+
+public extension ButtonType {
 
     var id: String { rawValue }
 
@@ -72,13 +73,19 @@ public extension Button.StandardType {
         }
     }
 
-    var keyboardShortcut: String? {
+    var keyboardShortcut: KeyEquivalent? {
         switch self {
         case .search: "f"
         default: nil
         }
     }
 
+    var keyboardShortcutModifier: EventModifiers? {
+        switch self {
+        default: .command
+        }
+    }
+
     var role: ButtonRole? {
         switch self {
         case .cancel: .cancel
@@ -110,6 +117,25 @@ public extension Button.StandardType {
         }
     }
 }
+
+public extension View {
+
+    @ViewBuilder
+    func keyboardShortcut(
+        _ button: ButtonType
+    ) -> some View {
+        if let shortcut = button.keyboardShortcut {
+            if let modifier = button.keyboardShortcutModifier {
+                self.keyboardShortcut(shortcut, modifiers: modifier)
+            } else {
+                self.keyboardShortcut(shortcut)
+            }
+        } else {
+            self
+        }
+    }
+}
+
 /*
 #Preview {