API Reference / Android Widgets / Filter Toggle
Apr. 24, 2019

Filter Toggle

About this widget #

Filter Toggle is a filtering view that displays any kind of filter, and lets the user refine the search results by toggling it on or off.

To add a filter toggle to your search experience, use these components:

  • Searcher: The Searcher that handles your searches.
  • FilterState: The current state of the filters.
  • FilterToggleViewModel: The logic applied to the filter.
  • FilterToggleView: The view that will render the filter toggle.
  • FilterPresenter: Optional. The presenter to customize the display of the filters.
See code examples

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
25
26
27
28
29
30
31
32
33

class MyActivity : AppCompatActivity() {

    val client = ClientSearch(
        ApplicationID("AJ0P3S7DWQ"),
        APIKey("YourAPIKey")
    )
    val index = client.initIndex(IndexName("YourIndexName"))
    val searcher = SearcherSingleIndex(index)
    val filterState = FilterState()
    val attribute = Attribute("facetName")
    val filter = Filter.Facet(attribute, "facetValue")
    val viewModel = FilterToggleViewModel(filter)
    val connection = ConnectionHandler()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val checkBox = CheckBox(this)
        val view: FilterToggleView = FilterToggleViewCompoundButton(checkBox)

        connection += searcher.connectFilterState(filterState)
        connection += viewModel.connectFilterState(filterState)
        connection += viewModel.connectView(view)

        searcher.searchAsync()
    }

    override fun onDestroy() {
        super.onDestroy()
        connection.disconnect()
        searcher.cancel()
    }
}

Parameters #

searcher #
type: Searcher
Required

The Searcher that handles your searches.
Edit
Copy 
1

viewModel.connectSearcher(searcher)
filterState #
type: FilterState
Required

The FilterState that will hold your filters.
Edit
Copy 
1

viewModel.connectFilterState(filterState)
filterToggleView #
type: FilterToggleView
Required

The view that will render the filter toggle.
Edit
Copy 
1

viewModel.connectView(filterToggleView)
filter #
type: Filter
Required

The filter to apply.
Edit
Copy 
1

FilterToggleViewModel(filter = Filter.Facet(Attribute("category"), "shoes"))
groupId #
type: FilterGroupID?
default: FilterGroupID(filter.value.attribute, FilterOperator.And)
Optional

When specified, the filter will be grouped under this ID and will be composed with this operator. Defaults to the attribute used, applying FilterOperator.And with any other filters of this group.
Edit
Copy 
1

viewModel.connectFilterState(filterState, FilterGroupID(FilterOperator.Or))
isSelected #
type: Boolean?
default: false
Optional

If true, the filter will be active when created.
Edit
Copy 
1

FilterToggleViewModel(filter, isSelected = true)

Presenter #

presenter #
type: FilterPresenter
default: FilterPresenterImpl()
Optional

A presenter describing how to display a filter.
Edit
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

val presenter = object : FilterPresenter {
    override val facetString: (Attribute, String, Boolean) -> String = { attribute, value, isNegated ->
        "$attribute: ${if (isNegated) "!" else ""}$value"
    }
    override val facetBoolean: (Attribute, Boolean, Boolean) -> String = { attribute, value, isNegated ->
        "$attribute: ${if (isNegated) "!" else ""}$value"
    }
    override val facetNumber: (Attribute, Number, Boolean) -> String = { attribute, value, isNegated ->
        "$attribute: ${if (isNegated) "!" else ""}$value"
    }
    override val tag: (Attribute, String, Boolean) -> String = { _, value, isNegated ->
        "tag: ${if (isNegated) "!" else ""}$value"
    }
    override val numericComparison: (Attribute, NumericOperator, Number, Boolean) -> String =
        { attribute, operator, value, isNegated ->
            "$attribute: ${if (isNegated) "!" else ""}$operator $value"
        }
    override val numericRange: (Attribute, Number, Number, Boolean) -> String =
        { attribute, lowerBound, upperBound, isNegated ->
            "${if (isNegated) "!" else ""}$lowerBound < $attribute <= $upperBound"
        }
}
viewModel.connectView(view, presenter)

Did you find this page helpful?

Android InstantSearch v2