An action that can end a search interaction.
Use the ``EnvironmentValues/dismissSearch`` environment value to get the
instance of this structure for a given ``Environment``. Then call the
instance to dismiss the current search interaction. You call the instance
directly because it defines a ``DismissSearchAction/callAsFunction()``
method that Swift calls when you call the instance.
When you dismiss search, SwiftUI:
* Sets ``EnvironmentValues/isSearching`` to `false`.
* Clears any text from the search field.
* Removes focus from the search field.
> Note: Calling this instance has no effect if the user isn't
interacting with a search field.
Use this action to dismiss a search operation based on
another user interaction. For example, consider a searchable
view with a ``Button`` that presents more information about the first
matching item from a collection:
struct ContentView: View {
@State private var searchText = ""
var body: some View {
NavigationStack {
SearchedView(searchText: searchText)
.searchable(text: $searchText)
}
}
}
struct SearchedView: View {
var searchText: String
let items = ["a", "b", "c"]
var filteredItems: [String] { items.filter { $0 == searchText.lowercased() } }
@State private var isPresented = false
@Environment(\.dismissSearch) private var dismissSearch
var body: some View {
if let item = filteredItems.first {
Button("Details about \(item)") {
isPresented = true
}
.sheet(isPresented: $isPresented) {
NavigationStack {
DetailView(item: item, dismissSearch: dismissSearch)
}
}
}
}
}
The button becomes visible only after the user enters search text
that produces a match. When the user taps the button, SwiftUI shows
a sheet that provides more information about the item, including
an Add button for adding the item to a stored list of items:
private struct DetailView: View {
var item: String
var dismissSearch: DismissSearchAction
@Environment(\.dismiss) private var dismiss
var body: some View {
Text("Information about \(item).")
.toolbar {
Button("Add") {
// Store the item here...
dismiss()
dismissSearch()
}
}
}
}
People can dismiss the sheet by dragging it down, effectively
canceling the operation, leaving the in-progress search interaction
intact. Alternatively, people can tap the Add button to store the item.
Because the person using your app is likely to be done with both the
detail view and the search interaction at this point, the button's
closure also uses the ``EnvironmentValues/dismiss`` property to dismiss
the sheet, and the ``EnvironmentValues/dismissSearch`` property to
reset the search field.
> Important: Access the action from inside the searched view, as the
example above demonstrates, rather than from the searched view’s
parent, or another hierarchy, like that of a sheet. SwiftUI sets the
value in the environment of the view that you apply the searchable
modifier to, and doesn’t propagate the value up the view hierarchy.
Members (1)
method · iOS 15.0+
callAsFunction
TypeScript
callAsFunction(): Promise<void>
Swift declaration
@MainActor @preconcurrency func callAsFunction()
Dismisses the current search operation, if any.
Don't call this method directly. SwiftUI calls it for you when you
call the ``DismissSearchAction`` structure that you get from the
``Environment``:
struct SearchedView: View {
@Environment(\.dismissSearch) private var dismissSearch
var body: some View {
Button("Cancel") {
dismissSearch() // Implicitly calls dismissSearch.callAsFunction()
}
}
}
For information about how Swift uses the `callAsFunction()` method to
simplify call site syntax, see
[Methods with Special Names](https://docs.swift.org/swift-book/ReferenceManual/Declarations.html#ID622)
in *The Swift Programming Language*.
