You are reading docs for v2, click here for the latest version.
- elements:utilities
- introduction
- getting-started
- routing
- utilities
- elements:layouts
- elements:action-bar
- elements:components
- elements:dialogs
- elements:utilities
SearchBar
This is an overview of the most common usage of SearchBar. For more information about the available properties, methods, or events, head over to the complete API documentation for SearchBar.
<SearchBar> is a UI component that provides a user interface for entering search queries and submitting requests to the search provider.
<SearchBar hint="Search hint" :text="searchPhrase" @textChange="onTextChanged" @submit="onSubmit" /><SearchBar> provides two-way data binding using v-model.
<SearchBar v-model="searchQuery" />
Props
| Name | Type | Description |
|---|---|---|
hint | String | Gets or sets placeholder text for the input area. |
text | String | Gets or sets the value of the search query. |
textFieldBackgroundColor | Color | Gets or sets the background color of the input area. |
textFieldHintColor | Color | Gets or sets the color of the placeholder text. |
Events
| name | description |
|---|---|
textChange | Emitted when the text is changed. |
submit | Emitted when the search input is submitted. |
clear | Emitted when the current search input is cleared through the X button in the input area. |
Native Component
| Android | iOS |
|---|---|
android.widget.SearchView | UISearchBar |
Contributors
