API Reference / React InstantSearch Hooks / <CurrentRefinements>
Signature
<CurrentRefinements
  // Optional props
  includedAttributes={string[]}
  excludedAttributes={string[]}
  transformItems={function}
  classNames={object}
  ...props={ComponentProps<'div'>}
/>

About this widget

<CurrentRefinements> is a widget that lets you display the list of active refinements in the search.

You can also create your own UI with useCurrentRefinements().

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
import React from 'react';
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch, CurrentRefinements } from 'react-instantsearch-hooks-web';

const searchClient = algoliasearch('YourApplicationID', 'YourSearchOnlyAPIKey');

function App() {
  return (
    <InstantSearch indexName="instant_search" searchClient={searchClient}>
      <CurrentRefinements />
    </InstantSearch>
  );
}

Props

includedAttributes
type: string[]
default: []

The attributes to include (all by default). This parameter can’t be used with excludedAttributes.

In the example below, only the categories attribute is included.

1
<CurrentRefinements includedAttributes={['categories']} />
excludedAttributes
type: string[]
default: ['query']

The attributes to exclude from the widget. This parameter can’t be used with includedAttributes.

In the example below, the brand attribute is excluded.

1
<CurrentRefinements excludedAttributes={['brand']} />
transformItems
type: UseCurrentRefinementsProps['transformItems']
default: items => items

Receives the items and is called before displaying them. Should return a new array with the same shape as the original array. Useful for transforming, removing, or reordering items.

In addition, the full results data is available, which includes all regular response parameters, as well as parameters from the helper (for example disjunctiveFacetsRefinements).

1
2
3
4
5
6
7
8
9
10
11
12
<CurrentRefinements
  transformItems={(items) => {
    return items.filter((item) => item.attribute !== 'brand');
  }}

  /* or, combined with results */
  transformItems={(items, { results }) => {
    return results.nbHits === 0
      ? items
      : items.filter(item => item.attribute !== 'brand');
  }}
/>
classNames
type: Partial<CurrentRefinementsClassNames>
Optional

CSS classes to pass to the widget’s elements. This is useful to style widgets with class-based CSS frameworks like Bootstrap or Tailwind CSS.

  • root: The root element of the widget.
  • noRefinementRoot: The root element when there are no refinements.
  • list: The list element.
  • noRefinementList: The list element when there are no refinements.
  • item: Each refinement element.
  • label: The label of each refinement.
  • category: The container of each refinement’s value.
  • categoryLabel: The text element of each refinement’s value.
  • delete: The delete button of each refinement.
1
2
3
4
5
6
<CurrentRefinements
  classNames={{
    root: 'MyCustomCurrentRefinements',
    list: 'MyCustomCurrentRefinementsList MyCustomCurrentRefinementsList--subclass',
  }}
/>
...props
type: React.ComponentProps<'div'>
Optional

Any <div> prop to forward to the root element of the widget.

1
2
3
4
<CurrentRefinements
  className="MyCustomCurrentRefinements"
  title="My custom title"
/>

Hook

React InstantSearch Hooks let you create your own UI for the <CurrentRefinements> widget with useCurrentRefinements(). Hooks provide APIs to access the widget state and interact with InstantSearch.

The useCurrentRefinements() Hook accepts parameters and returns APIs.

Usage

First, create your React component:

import { useCurrentRefinements } from 'react-instantsearch-hooks-web';

function CustomCurrentRefinements(props) {
  const { items, canRefine, refine } = useCurrentRefinements(props);

  return <>{/* Your JSX */}</>;
}

Then, render the widget:

<CustomCurrentRefinements {...props} />

Parameters

Hooks accept parameters. You can pass them manually, or forward the props from your custom component.

When you provide a function to Hooks, make sure to pass a stable reference with useCallback() to avoid rendering endlessly. Objects and arrays are memoized so you don’t have to stabilize them.

includedAttributes
type: string[]
default: []

The attributes to include (all by default). This parameter can’t be used with excludedAttributes.

In the example below, only the categories attribute is included.

1
2
3
const currentRefinementsApi = useCurrentRefinements({
  includedAttributes: ['categories'],
});
excludedAttributes
type: string[]
default: ['query']

The attributes to exclude from the widget. This parameter can’t be used with includedAttributes.

In the example below, the brand attribute is excluded.

1
2
3
const currentRefinementsApi = useCurrentRefinements({
  excludedAttributes: ['brand'],
});
transformItems
type: UseCurrentRefinementsProps['transformItems']
default: items => items

Receives the items and is called before displaying them. Should return a new array with the same shape as the original array. Useful for transforming, removing, or reordering items.

In addition, the full results data is available, which includes all regular response parameters, as well as parameters from the helper (for example disjunctiveFacetsRefinements).

1
2
3
4
5
6
7
8
9
10
11
12
const currentRefinementsApi = useCurrentRefinements({
  transformItems(items) {
    return items.filter((item) => item.attribute !== 'brand');
  },

  /* or, combined with results */
  transformItems(items, { results }) {
    return results.nbHits === 0
      ? items
      : items.filter(item => item.attribute !== 'brand');
  },
});

APIs

Hooks return APIs, such as state and functions. You can use them to build your UI and interact with React InstantSearch.

items
type: CurrentRefinementsItem[]

All the currently refined items grouped by attribute.

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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
type CurrentRefinementsItem = {
  /**
   * The index name.
   */
  indexName: string;
  /**
   * The attribute on which the refinement is applied.
   */
  attribute: string;
  /**
   * The textual representation of this attribute.
   */
  label: string;
  /**
   * Currently applied refinements.
   */
  refinements: CurrentRefinementsRefinement[];
  /**
   * Removes the given refinement and triggers a new search.
   */
  refine(refinement: CurrentRefinementsRefinement): void;
};

type CurrentRefinementsRefinement = {
  /**
   * The attribute on which the refinement is applied.
   */
  attribute: string;
  /**
   * The type of the refinement.
   *
   * It can be one of those: 'facet'|'exclude'|'disjunctive'|'hierarchical'|'numeric'|'query'|'tag'.
   */
  type: string;
  /**
   * The raw value of the refinement.
   */
  value: string | number;
  /**
   * The label of the refinement to display.
   */
  label: string;
  /**
   * The value of the operator (only if applicable).
   */
  operator?: string;
  /**
   * The number of found items (only if applicable).
   */
  count?: number;
  /**
   * Whether the count is exhaustive (only if applicable).
   */
  exhaustive?: boolean;
};
canRefine
type: boolean

Whether the search state can be refined.

refine
type: (value: CurrentRefinementsItem) => void

Clears a single refinement and triggers a new search.

Example

1
2
3
4
5
6
7
8
import React from 'react';
import { useCurrentRefinements } from 'react-instantsearch-hooks-web';

function CustomCurrentRefinements(props) {
  const { items, refine } = useCurrentRefinements(props);

  return <>{/* Your JSX */}</>;
}
Did you find this page helpful?