added focusable Modifier & AppKit implementation for all views in ControlsExample

Author: MiaKoring

Examples/Sources/ControlsExample/ControlsApp.swift

@@ -16,6 +16,7 @@ struct ControlsApp: App {
     @State var text = ""
     @State var flavor: String? = nil
     @State var enabled = true
+    @State var isFocusable = true
 
     var body: some Scene {
         WindowGroup("ControlsApp") {
@@ -78,10 +79,20 @@ struct ControlsApp: App {
                         Text("You chose: \(flavor ?? "Nothing yet!")")
                     }
                 }.padding().disabled(!enabled)
+                    .focusable(isFocusable)
 
                 Toggle(enabled ? "Disable all" : "Enable all", active: $enabled)
                     .padding()
+                    .focusable(isFocusable)
+
+                Toggle(
+                    isFocusable ? "Disable focusability for all" : "Enable focusability for all",
+                    active: $isFocusable
+                )
+                .padding()
+                .focusable(isFocusable)
             }
+
         }.defaultSize(width: 400, height: 600)
     }
 }

Sources/AppKitBackend/AppKitBackend.swift

@@ -576,7 +576,7 @@ public final class AppKitBackend: AppBackend {
     }
 
     public func createButton() -> Widget {
-        return NSButton(title: "", target: nil, action: nil)
+        return NSCustomButton(title: "", target: nil, action: nil)
     }
 
     public func updateButton(
@@ -585,43 +585,45 @@ public final class AppKitBackend: AppBackend {
         environment: EnvironmentValues,
         action: @escaping () -> Void
     ) {
-        let button = button as! NSButton
+        let button = button as! NSCustomButton
         button.attributedTitle = Self.attributedString(
             for: label,
             in: environment.with(\.multilineTextAlignment, .center)
         )
         button.bezelStyle = .regularSquare
         button.appearance = environment.colorScheme.nsAppearance
         button.isEnabled = environment.isEnabled
+        button.canBeFocused = environment.isFocusable
         button.onAction = { _ in
             action()
         }
     }
 
     public func createSwitch() -> Widget {
-        return NSSwitch()
+        return NSCustomSwitch()
     }
 
     public func updateSwitch(
         _ toggleSwitch: Widget,
         environment: EnvironmentValues,
         onChange: @escaping (Bool) -> Void
     ) {
-        let toggleSwitch = toggleSwitch as! NSSwitch
+        let toggleSwitch = toggleSwitch as! NSCustomSwitch
         toggleSwitch.isEnabled = environment.isEnabled
+        toggleSwitch.canBeFocused = environment.isFocusable
         toggleSwitch.onAction = { toggleSwitch in
-            let toggleSwitch = toggleSwitch as! NSSwitch
+            let toggleSwitch = toggleSwitch as! NSCustomSwitch
             onChange(toggleSwitch.state == .on)
         }
     }
 
     public func setState(ofSwitch toggleSwitch: Widget, to state: Bool) {
-        let toggleSwitch = toggleSwitch as! NSSwitch
+        let toggleSwitch = toggleSwitch as! NSCustomSwitch
         toggleSwitch.state = state ? .on : .off
     }
 
     public func createToggle() -> Widget {
-        let toggle = NSButton()
+        let toggle = NSCustomButton()
         toggle.setButtonType(.pushOnPushOff)
         return toggle
     }
@@ -632,47 +634,49 @@ public final class AppKitBackend: AppBackend {
         environment: EnvironmentValues,
         onChange: @escaping (Bool) -> Void
     ) {
-        let toggle = toggle as! NSButton
+        let toggle = toggle as! NSCustomButton
         toggle.attributedTitle = Self.attributedString(
             for: label,
             in: environment.with(\.multilineTextAlignment, .center)
         )
         toggle.isEnabled = environment.isEnabled
+        toggle.canBeFocused = environment.isFocusable
         toggle.onAction = { toggle in
-            let toggle = toggle as! NSButton
+            let toggle = toggle as! NSCustomButton
             onChange(toggle.state == .on)
         }
     }
 
     public func setState(ofToggle toggle: Widget, to state: Bool) {
-        let toggle = toggle as! NSButton
+        let toggle = toggle as! NSCustomButton
         toggle.state = state ? .on : .off
     }
 
     public func createCheckbox() -> Widget {
-        NSButton(checkboxWithTitle: "", target: nil, action: nil)
+        NSCustomButton(checkboxWithTitle: "", target: nil, action: nil)
     }
 
     public func updateCheckbox(
         _ checkbox: Widget,
         environment: EnvironmentValues,
         onChange: @escaping (Bool) -> Void
     ) {
-        let checkbox = checkbox as! NSButton
+        let checkbox = checkbox as! NSCustomButton
         checkbox.isEnabled = environment.isEnabled
+        checkbox.canBeFocused = environment.isFocusable
         checkbox.onAction = { toggle in
-            let checkbox = toggle as! NSButton
+            let checkbox = toggle as! NSCustomButton
             onChange(checkbox.state == .on)
         }
     }
 
     public func setState(ofCheckbox checkbox: Widget, to state: Bool) {
-        let toggle = checkbox as! NSButton
+        let toggle = checkbox as! NSCustomButton
         toggle.state = state ? .on : .off
     }
 
     public func createSlider() -> Widget {
-        return NSSlider()
+        return NSCustomSlider()
     }
 
     public func updateSlider(
@@ -684,23 +688,24 @@ public final class AppKitBackend: AppBackend {
         onChange: @escaping (Double) -> Void
     ) {
         // TODO: Implement decimalPlaces
-        let slider = slider as! NSSlider
+        let slider = slider as! NSCustomSlider
         slider.minValue = minimum
         slider.maxValue = maximum
         slider.onAction = { slider in
-            let slider = slider as! NSSlider
+            let slider = slider as! NSCustomSlider
             onChange(slider.doubleValue)
         }
+        slider.canBeFocused = environment.isFocusable
         slider.isEnabled = environment.isEnabled
     }
 
     public func setValue(ofSlider slider: Widget, to value: Double) {
-        let slider = slider as! NSSlider
+        let slider = slider as! NSCustomSlider
         slider.doubleValue = value
     }
 
     public func createPicker() -> Widget {
-        return NSPopUpButton()
+        return NSCustomPopUpButton()
     }
 
     public func updatePicker(
@@ -709,7 +714,7 @@ public final class AppKitBackend: AppBackend {
         environment: EnvironmentValues,
         onChange: @escaping (Int?) -> Void
     ) {
-        let picker = picker as! NSPopUpButton
+        let picker = picker as! NSCustomPopUpButton
         picker.isEnabled = environment.isEnabled
         picker.menu?.removeAllItems()
         for option in options {
@@ -718,14 +723,15 @@ public final class AppKitBackend: AppBackend {
             picker.menu?.addItem(item)
         }
         picker.onAction = { picker in
-            let picker = picker as! NSPopUpButton
+            let picker = picker as! NSCustomPopUpButton
             onChange(picker.indexOfSelectedItem)
         }
+        picker.canBeFocused = environment.isFocusable
         picker.bezelStyle = .regularSquare
     }
 
     public func setSelectedOption(ofPicker picker: Widget, to selectedOption: Int?) {
-        let picker = picker as! NSPopUpButton
+        let picker = picker as! NSCustomPopUpButton
         if let index = selectedOption {
             picker.selectItem(at: index)
         } else {
@@ -760,6 +766,7 @@ public final class AppKitBackend: AppBackend {
             onChange(textField.stringValue)
         }
         textField.onSubmit = onSubmit
+        textField.canBeFocused = environment.isFocusable
 
         if #available(macOS 14, *) {
             textField.contentType =
@@ -813,6 +820,7 @@ public final class AppKitBackend: AppBackend {
         }
         textEditor.appearance = environment.colorScheme.nsAppearance
         textEditor.isEditable = environment.isEnabled
+        textEditor.canBeFocused = environment.isFocusable
 
         if #available(macOS 14, *) {
             textEditor.contentType =
@@ -1963,11 +1971,49 @@ final class ObjectAssociation<T: Any> {
     }
 }
 
+final class NSCustomButton: NSButton {
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+}
+
+final class NSCustomSlider: NSSlider {
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+}
+
+final class NSCustomSwitch: NSSwitch {
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+}
+
+final class NSCustomPopUpButton: NSPopUpButton {
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+}
+
 class NSObservableTextField: NSTextField {
     override func textDidChange(_ notification: Notification) {
         onEdit?(self)
     }
 
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+
     var onEdit: ((NSTextField) -> Void)?
     var _onSubmitAction = Action({})
     var onSubmit: () -> Void {
@@ -1987,6 +2033,12 @@ class NSObservableTextView: NSTextView, NSTextViewDelegate {
         onEdit?(self)
     }
 
+    var canBeFocused: Bool = true
+
+    override var acceptsFirstResponder: Bool {
+        return canBeFocused
+    }
+
     var onEdit: ((NSTextView) -> Void)?
 }
 

Sources/SwiftCrossUI/Environment/EnvironmentValues.swift

@@ -95,6 +95,9 @@ public struct EnvironmentValues {
     /// The style of toggle to use.
     public var toggleStyle: ToggleStyle
 
+    /// Wether a View is focusable
+    public var isFocusable: Bool
+
     // Backing storage for extensible subscript
     private var extraValues: [ObjectIdentifier: Any]
 
@@ -208,6 +211,7 @@ public struct EnvironmentValues {
         toggleStyle = .button
         isEnabled = true
         scrollDismissesKeyboardMode = .automatic
+        isFocusable = true
     }
 
     /// Returns a copy of the environment with the specified property set to the

Sources/SwiftCrossUI/Views/Modifiers/FocusableModifier.swift

@@ -0,0 +1,10 @@
+extension View {
+    /// Set wether a View is focusable
+    /// Only has effect on out of the box interactable Views
+    /// doesn't work on Views using onTapGesture instead of Button
+    public func focusable(_ isFocusable: Bool = true) -> some View {
+        EnvironmentModifier(self) { environment in
+            environment.with(\.isFocusable, isFocusable)
+        }
+    }
+}