API Reference
/
Android Widgets
/
SearchBox
Sep. 02, 2020
SearchBox
Widget signature
SearchBoxConnector( searcher: Searcher viewModel: SearchBoxViewModel searchMode: SearchMode debouncer: Debouncer )
About this widget
The SearchBox is used to perform a text-based query.
To add a SearchBox to your search experience, use these components:
Searcher: TheSearcherthat handles your searches.SearchBoxViewModel: The business logic that handles new search inputs.SearchBoxView: The view that handles the input.
Examples
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
class MyActivity : AppCompatActivity() {
val client = ClientSearch(
ApplicationID("YourApplicationID"),
APIKey("YourAPIKey")
)
val index = client.initIndex(IndexName("YourIndexName"))
val searcher = SearcherSingleIndex(index)
val searchBox = SearchBoxConnector(searcher)
val connection = ConnectionHandler()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val searchView = SearchView(this)
val view: SearchBoxView = SearchBoxViewAppCompat(searchView)
connection += searchBox.connectView(view)
searcher.searchAsync()
}
override fun onDestroy() {
super.onDestroy()
connection.disconnect()
searcher.cancel()
}
}
Parameters
searcher
|
type: Searcher
Required
The |
viewModel
|
type: SearchBoxViewModel
default: SearchBoxViewModel()
Optional
The business logic that handles new search inputs. |
searchMode
|
type: SearchMode
default: SearchMode.AsYouType
Optional
|
debouncer
|
type: Debouncer
default: Debouncer(debounceLoadingInMillis)
Optional
Delays searcher operations by a specified time duration. |
View
searchBoxView
|
type: SearchBoxView
Required
The view that handles the input. |
||
|
Copy
|
|||
