SwiftUI macOS下使用defaultFocus设置默认按钮焦点无效问题

问题描述 #

开发macOS应用时，尝试通过SwiftUI的Focus子系统让指定按钮默认获得焦点，但使用prefersDefaultFocus和defaultFocus均未生效，代码如下：

struct ContentView: View {

    @FocusState private var focusedElement: FocusedElement?
    @Namespace private var namespace

    var body: some View {
        VStack {
            self.makeButton(element: .button1)
            self.makeButton(element: .button2)
                .prefersDefaultFocus(in: self.namespace) // 无效果
        }
        .defaultFocus(self.$focusedElement, .button2) // 无效果
        .focusScope(self.namespace)
        .onChange(of: self.focusedElement) { newValue in
            print("focusedElement:", newValue.debugDescription )
        }
    }
}

private extension ContentView {

    enum FocusedElement: Hashable, Identifiable {
        case button2
        case button1

        var id: FocusedElement { self }
    }

    @ViewBuilder
    func makeButton(element: FocusedElement) -> some View {
        Button(action: { }, label: {
            Text(String(describing: element))
        })
        .id(element)
        .focused(self.$focusedElement, equals: element)
    }
}

问题原因与解决方案 #

焦点失效主要是因为API使用顺序错误、参数格式不正确，以及macOS焦点系统的触发逻辑特性，修正方案如下：

1. 修正defaultFocus的使用方式 #

• defaultFocus必须放在focusScope之后，才能正确关联到指定的焦点作用域
• 第二个参数需要明确使用equals:标签，原代码省略标签导致逻辑不生效

2. 主动在视图加载时设置焦点 #

macOS的SwiftUI焦点系统有时不会自动触发默认焦点，通过onAppear直接设置FocusState的值，确保视图加载完成后目标按钮获得焦点

修正后的代码 #

struct ContentView: View {

    @FocusState private var focusedElement: FocusedElement?
    @Namespace private var namespace

    var body: some View {
        VStack {
            makeButton(element: .button1)
            makeButton(element: .button2)
        }
        .focusScope(namespace)
        .defaultFocus($focusedElement, equals: .button2) // 调整顺序并修正参数
        .onAppear {
            // 主动设置焦点确保生效
            focusedElement = .button2
        }
        .onChange(of: focusedElement) { newValue in
            print("focusedElement:", newValue.debugDescription )
        }
    }
}

private extension ContentView {

    enum FocusedElement: Hashable, Identifiable {
        case button2
        case button1

        var id: FocusedElement { self }
    }

    @ViewBuilder
    func makeButton(element: FocusedElement) -> some View {
        Button(action: { }, label: {
            Text(String(describing: element))
        })
        .id(element)
        .focused($focusedElement, equals: element)
    }
}

关键说明 #

• 移除了无效的prefersDefaultFocus：该修饰符主要用于标记焦点候选，但结合FocusState的绑定方式时，直接通过defaultFocus或主动设置状态更可靠
• 确保focusScope在defaultFocus之前：作用域必须先定义，才能让默认焦点规则生效
• onAppear主动设置焦点：弥补macOS焦点系统自动触发的不确定性，确保目标按钮稳定获得初始焦点

内容的提问来源于stack exchange，提问作者Tom Kraina