Overloads
2 ways to call compose().focused(). Each is one SwiftUI overload, picked by the arguments you pass.
compose().focused(condition: Binding<boolean>)nonisolated func focused(
_ condition: FocusState<Bool>.Binding
) -> some ViewParameters
condition*Binding<boolean>The focus state to bind. When focus moves to the view, the binding sets the bound value to
true. If a caller sets the value totrueprogrammatically, then focus moves to the modified view. When focus leaves the modified view, the binding sets the value tofalse. If a caller sets the value tofalse, SwiftUI automatically dismisses focus.
Return value
The modified view.
Discussion
Use this modifier to cause the view to receive focus whenever the
condition value is true. You can use this modifier to
observe the focus state of a single view, or programmatically set and
remove focus from the view.
In the following example, a single TextField accepts a user's
desired username. The text field binds its focus state to the
Boolean value usernameFieldIsFocused. A "Submit" button's action
verifies whether the name is available. If the name is unavailable, the
button sets usernameFieldIsFocused to true, which causes focus to
return to the text field, so the user can enter a different name.
@State private var username: String = ""
@FocusState private var usernameFieldIsFocused: Bool
@State private var showUsernameTaken = false
var body: some View {
VStack {
TextField("Choose a username.", text: $username)
.focused($usernameFieldIsFocused)
if showUsernameTaken {
Text("That username is taken. Please choose another.")
}
Button("Submit") {
showUsernameTaken = false
if !isUserNameAvailable(username: username) {
usernameFieldIsFocused = true
showUsernameTaken = true
}
}
}
}To control focus by matching a value, use the
View.focused(_:equals:) method instead.
See also
More in Focus.
- defaultFocusDefines a region of the window in which default focus is evaluated by assigning a value to a given focus state binding.
- focusableSpecifies if the view is focusable.
- focusEffectDisabledAdds a condition that controls whether this view can display focus effects, such as a default focus ring or hover effect.
- searchFocusedModifies this view by binding the focus state of the search field associated with the nearest searchable modifier to the given Boolean value.