Filter List (Tag)
FilterListConnector.Tag( filters: List<Filter.Tag>, filterState: FilterState, selectionMode: SelectionMode, groupID: FilterGroupID )
About this widget
FilterList.Tag
is a filtering view that displays any kind of tag filters and lets the user refine the search results by selecting them.
Compared to the RefinementList
, which takes its values from the search response facets, this widget displays tag filters that you add yourself.
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class MyActivity : AppCompatActivity() {
val client = ClientSearch(
ApplicationID("YourApplicationID"),
APIKey("YourAPIKey")
)
val index = client.initIndex(IndexName("YourIndexName"))
val searcher = SearcherSingleIndex(index)
val filterState = FilterState()
val tags = Attribute("_tags")
val groupTags = groupOr(tags)
val filters = listOf(
Filter.Tag("free shipping"),
Filter.Tag("coupon"),
Filter.Tag("free return"),
Filter.Tag("on sale"),
Filter.Tag("no exchange")
)
val filterListConnector = FilterListConnector.Tag(
filters = filters,
filterState = filterState,
groupID = groupTags
)
val connection = ConnectionHandler(filterListConnector, searcher.connectFilterState(filterState))
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val filterListView: FilterListView.Tag = MyFilterListTagAdapter() // your `FilterListView.Tag` implementation
connection += filterListConnector.connectView(filterListView)
searcher.searchAsync()
}
override fun onDestroy() {
super.onDestroy()
connection.disconnect()
searcher.cancel()
}
}
Low-level API
If you want to fully control the FilterList.Tag
components and connect them manually, use the following components:
Searcher
: TheSearcher
that handles your searches.FilterState
: The current state of the filters.FilterListViewModel.Tag
: The logic applied to the tag filters.FilterListView.Tag
: The view that renders the tag filters.FilterPresenter
: Optional. The presenter to customize the display of the filters.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class MyActivity : AppCompatActivity() {
val client = ClientSearch(
ApplicationID("YourApplicationID"),
APIKey("YourAPIKey")
)
val index = client.initIndex(IndexName("YourIndexName"))
val searcher = SearcherSingleIndex(index)
val filterState = FilterState()
val filters = listOf(
Filter.Tag("free shipping"),
Filter.Tag("coupon"),
Filter.Tag("free return"),
Filter.Tag("on sale"),
Filter.Tag("no exchange")
)
val viewModel = FilterListViewModel.Tag(filters)
val connection = ConnectionHandler()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val view: FilterListView.Tag = MyFilterListTagAdapter() // your `FilterListView.Tag` implementation
connection += searcher.connectFilterState(filterState)
connection += viewModel.connectFilterState(filterState)
connection += viewModel.connectView(view)
searcher.searchAsync()
}
override fun onDestroy() {
super.onDestroy()
connection.disconnect()
searcher.cancel()
}
}
Parameters
filters
|
type: List<Filter.Tag>
Required
The tag filters to display. |
filterState
|
type: FilterState
Required
The |
selectionMode
|
type: SelectionMode
default: Multiple
Optional
Whether the list can have |
groupID
|
type: FilterGroupID
default: FilterGroupID(FilterOperator.And)
Optional
The identifier for the group of filters. |
View
view
|
type: FilterListView.Tag
Required
The view that renders the tag filters. |
||
Copy
|