searchable(text:editableTokens:placement:prompt:token:)
Marks this view as searchable, which configures the display of a search field.
Declaration
nonisolated func searchable<C>(text: Binding<String>, editableTokens: Binding<C>, placement: SearchFieldPlacement = .automatic, prompt: LocalizedStringKey, @ViewBuilder token: @escaping (Binding<C.Element>) -> some View) -> some View where C : RandomAccessCollection, C : RangeReplaceableCollection, C.Element : Identifiable
Parameters
- text:
The text to display and edit in the search field.
- editableTokens:
A collection of tokens to display and edit in the search field.
- placement:
The preferred placement of the search field within the containing view hierarchy.
- prompt:
The key for the localized prompt of the search field which provides users with guidance on what to search for.
- token:
A view builder that creates a view given an element in tokens.
Discussion
For more information about using searchable modifiers, see Adding a search interface to your app.