CurrentRefinements | React InstantSearch V6 (Deprecated)

Deprecated content

This documentation is for a deprecated version of React InstantSearch. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of React InstantSearch for up-to-date information.

Signature

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

The CurrentRefinements widget displays the list of currently applied refinements.

Examples

Copy
import { CurrentRefinements } from 'react-instantsearch-dom';

<CurrentRefinements />

Props

`clearsQuery`

Optional

Type: boolean

Whether the widget should include the query.

Copy
<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.

Copy
<CurrentRefinements
  transformItems={items =>
    items.filter(item => item.attribute !== 'brand')
  }
/>

Did you find this page helpful?