Instance Method インスタンスメソッド

focused(_:equals:)

Modifies this view by binding its focus state to the given state value.

Declaration 宣言 

func focused<Value>(_ binding: FocusState<Value>.Binding, equals value: Value) -> some View where Value : Hashable

Return Value 戻り値

The modified view.

Parameters パラメータ

binding

The state binding to register. When focus moves to the modified view, the binding sets the bound value to the corresponding match value. If a caller sets the state value programmatically to the matching value, then focus moves to the modified view. When focus leaves the modified view, the binding sets the bound value to nil. If a caller sets the value to nil, SwiftUI automatically dismisses focus.

value

The value to match against when determining whether the binding should change.

Discussion 議論

Use this modifier to cause the view to receive focus whenever the the binding equals the value. Typically, you create an enumeration of fields that may receive focus, bind an instance of this enumeration, and assign its cases to focusable views.

The following example uses the cases of a LoginForm enumeration to bind the focus state of two TextField views. A sign-in button validates the fields and sets the bound focusedField value to any field that requires the user to correct a problem.


struct LoginForm {
    enum Field: Hashable {
        case usernameField
        case passwordField
    }


    @State private var username = ""
    @State private var password = ""
    @FocusState private var focusedField: Field?


    var body: some View {
        Form {
            TextField("Username", text: $username)
                .focused($focusedField, equals: .usernameField)


            SecureField("Password", text: $password)
                .focused($focusedField, equals: .passwordField)


            Button("Sign In") {
                if username.isEmpty {
                    focusedField = .usernameField
                } else if password.isEmpty {
                    focusedField = .passwordField
                } else {
                    handleLogin(username, password)
                }
            }
        }
    }
}

To control focus using a Boolean, use the focused(_:) method instead.

See Also 参照

Focus

func focused(FocusState<Bool>.Binding) -> some View
Modifies this view by binding its focus state to the given Boolean state value.
func focusedValue<Value>(WritableKeyPath<FocusedValues, Value?>, Value) -> some View
Modifies this view by injecting a value that you provide for use by other views whose state depends on the focused view hierarchy. このビューを修正します、フォーカスされたビュー階層にそれの状態が依存する他のビューで使うためにあなたが提供するある値を注入することによって。
func focusedSceneValue<T>(WritableKeyPath<FocusedValues, T?>, T) -> some View
Modifies this view by injecting a value that you provide for use by other views whose state depends on the focused scene.
func prefersDefaultFocus(Bool, in: Namespace.ID) -> some View
Indicates that the view should receive focus by default for a given namespace.
func focusScope(Namespace.ID) -> some View
Creates a focus scope that SwiftUI uses to limit default focus preferences.
func focusSection() -> some View
Indicates that the view’s frame and cohort of focusable descendants should be used to guide focus movement.
func focusable(Bool) -> some View
Specifies if the view is focusable.