InstantSearch / React / V6 / API reference

CurrentRefinements | React InstantSearch V6 (Deprecated)

This version of React InstantSearch has been deprecated in favor of the latest version of React InstantSearch.

Signature

Signature
<CurrentRefinements
  // Optional parameters
  clearsQuery={boolean}
  transformItems={function}
/>

About this widget

The CurrentRefinements widget displays the list of currently applied refinements.

Examples

1
2
3
import { CurrentRefinements } from 'react-instantsearch-dom';

<CurrentRefinements />

Props

clearsQuery

Optional
Type: boolean

Whether the widget should include the query.

1
<CurrentRefinements clearsQuery />

transformItems

Optional
Type: function

Modifies the items being displayed, for example, to filter or sort them. It takes items as argument and expects them back in return.

1
2
3
4
5
<CurrentRefinements
  transformItems={items =>
    items.filter(item => item.attribute !== 'brand')
  }
/>
Did you find this page helpful?