Skip to main content
Signature
FilterClearConnector(
    filterState: FilterState,
    groupIDs: List<FilterGroupID>,
    mode: ClearMode,
    viewModel: FilterClearViewModel
)
Explore example code

​
About this widget

ClearFilters lets users clear all refinements that are currently active within the given FilterState. To add ClearFilters to your search experience, use these components:
  • FilterClearViewModel. The logic for clearing refinements in the FilterState.
  • FilterState. The current state of the filters.
  • FilterClearView. The view that renders the clear filter UI.

​
Examples

Kotlin
class MyActivity : AppCompatActivity() {
    val searcher = HitsSearcher(
        applicationID = ApplicationID("YourApplicationID"),
        apiKey = APIKey("YourSearchOnlyAPIKey"),
        indexName = IndexName("YourIndexName")
    )
    val color = Attribute("color")
    val category = Attribute("category")
    val groupColor = groupOr(color)
    val groupCategory = groupOr(category)
    val filters = filters {
        group(groupColor) {
            facet(color, "red")
            facet(color, "green")
        }
        group(groupCategory) {
            facet(category, "shoe")
        }
    }
    val filterState = FilterState(filters)
    val clearAll = FilterClearConnector(filterState = filterState)
    val clearSpecified = FilterClearConnector(
        filterState = filterState,
        groupIDs = listOf(groupColor),
        mode = ClearMode.Specified
    )
    val clearExcept = FilterClearConnector(
        filterState = filterState,
        groupIDs = listOf(groupColor),
        mode = ClearMode.Except
    )
    val connection = ConnectionHandler(
        clearSpecified, clearExcept, searcher.connectFilterState(filterState)
    )

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        connection += clearAll.connectView(FilterClearViewImpl(filtersClearAll))
        connection += clearSpecified.connectView(FilterClearViewImpl(buttonClearSpecified))
        connection += clearExcept.connectView(FilterClearViewImpl(buttonClearExcept))
        searcher.searchAsync()
    }

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

​
Compose UI

InstantSearch provides the FilterClear as a state model, which is an implementation of the FilterClearView interface. You need to connect FilterClear to the FilterClearConnector or FilterClearViewModel like any other FilterClearView implementation.
Kotlin
class MyActivity : AppCompatActivity() {
    val searcher = HitsSearcher(
        applicationID = ApplicationID("YourApplicationID"),
        apiKey = APIKey("YourSearchOnlyAPIKey"),
        indexName = IndexName("YourIndexName")
    )
    val color = Attribute("color")
    val category = Attribute("category")
    val groupColor = groupOr(color)
    val groupCategory = groupOr(category)
    val filters = filters {
        group(groupColor) {
            facet(color, "red")
            facet(color, "green")
        }
        group(groupCategory) {
            facet(category, "shoe")
        }
    }
    val filterState = FilterState()
    val filterClear = FilterClear()
    val clearAll = FilterClearConnector(filterState = filterState)
    val connections = ConnectionHandler(clearAll)

    init {
        connections += searcher.connectFilterState(filterState)
        connections += clearAll.connectView(filterClear)
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            MyClearButton(clearAll) // your own composable to trigger filter clear
        }
        searcher.searchAsync()
    }

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

​
Parameters

​
filterState
FilterState
required
The FilterState that will hold your filters.
​
groupIDs
List<FilterGroupID>
default: listOf()
The group IDs of filters to clear. All filters will be cleared if unspecified.
​
mode
ClearMode
default: ClearMode.Specified
Whether we should clear the Specified filters or all filters Except them.
​
viewModel
FilterClearViewModel
default: FilterClearViewModel()
The logic for clearing refinements in the FilterState.

​
View

​
view
FilterClearView
required
The view that renders the clear filter UI.
Kotlin
val view = FilterClearViewImpl(myButton) // using your own Android view
filterClearConnector.connectView(view)
⌘I