What is React InstantSearch?

This is the React InstantSearch v7 documentation. React InstantSearch v7 is the latest version of React InstantSearch and the stable version of React InstantSearch Hooks.

If you were using React InstantSearch v6, you can upgrade to v7.

If you were using React InstantSearch Hooks, you can still use the React InstantSearch v7 documentation, but you should check the upgrade guide for necessary changes.

If you want to keep using React InstantSearch v6, you can find the archived documentation.

React InstantSearch is an open source UI library for React that lets you quickly build a search interface in your frontend application.

InstantSearch’s goal is to help you implement awesome search experiences as smoothly as possible by providing a complete search ecosystem. InstantSearch tackles an important part of this vast goal by providing frontend primitives that you can assemble into unique search interfaces.

It’s compatible with server-side rendering and has full routing capabilities.

The InstantSearch family is composed of multiple InstantSearch flavors:

A versatile React API

React InstantSearch lets you compose your search experience with predefined UI widgets, or go headless and take full control of the rendering with Hooks.

1. The easiest way to get started is by composing your UI with predefined widgets. You can configure them and get a fully functional UI which you can style with CSS.
2. Eventually, you might need to control the output of a widget (to work with a component library or with React Native). You can do this by using Hooks and render exactly what you want.
3. Finally, if you want to implement a widget that doesn’t exist yet, you can create custom Hooks. This gives you full control over the behavior.

Using UI widgets

The recommended way to use React InstantSearch is to use predefined widgets such as <SearchBox> or <RefinementList>.

Widgets provide features and a rendered output. You can place them anywhere on your UI, configure them, and style them with CSS.

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

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

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

The <InstantSearch> provider connects your InstantSearch app to your Algolia application. It accepts a search client and the index to search into.

Then, the <RefinementList> widget lists the brands, allowing your users to “refine” their search by brand.

Using Hooks

Eventually, you might need to control the render output of a widget. This can happen when using React InstantSearch together with a component library like Material UI, or when rendering to a non-DOM target like React Native.

To do so, you can use Hooks like useSearchBox() or useRefinementList(). Hooks return the necessary APIs for you to build the UI as you see fit.

Here’s an example of a custom <RefinementList> component created with useRefinementList(), and mounted in the <InstantSearch> provider.

1
2
3
4
5
6
7
8
9
10
11
12
13
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch } from 'react-instantsearch';
import { RefinementList } from './RefinementList';

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

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

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
import { useRefinementList } from 'react-instantsearch';

export function RefinementList(props) {
  // Retrieves the refinement `items` and the `refine` function to update the
  // refinement
  const { items, refine } = useRefinementList(props);

  return (
    <div className="ais-RefinementList">
      <ul className="ais-RefinementList-list">
        {items.map((item) => (
          <li
            key={item.value}
            className={cx(
              'ais-RefinementList-item',
              item.isRefined && 'ais-RefinementList-item--selected'
            )}
          >
            <label className="ais-RefinementList-label">
              <input
                className="ais-RefinementList-checkbox"
                type="checkbox"
                value={item.value}
                checked={item.isRefined}
                onChange={() => refine(item.value)}
              />
              <span className="ais-RefinementList-labelText">{item.label}</span>
              <span className="ais-RefinementList-count">{item.count}</span>
            </label>
          </li>
        ))}
      </ul>
    </div>
  );
}

function cx(...classNames) {
  return classNames.filter(Boolean).join(' ');
}

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
import algoliasearch from 'algoliasearch/lite';
import React, { useCallback } from 'react';
import { InstantSearch, useHits } from 'react-instantsearch';

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

function Search({ cartItems }) {
  const transformItems = useCallback(
    (items) =>
      items.map((item) => ({
        ...item,
        isInCart: Boolean(
          cartItems.find((cartItem) => cartItem.objectID === item.objectID)
        ),
      })),
    [cartItems]
  );
  const { hits } = useHits({ transformItems });

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

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

Creating your own Hooks

React InstantSearch works with all InstantSearch.js connectors: from Algolia, from the community, or even with your own.

To create your own Hook, you first need to create your connector.

Then, you can use useConnector() to turn your connector into a Hook:

1
2
3
4
5
6
import { useConnector } from 'react-instantsearch';
import { connectMyWidget } from './connectMyWidget';

export function useMyWidget(props) {
  return useConnector(connectMyWidget, props);
}

1
2
3
4
5
6
7
8
import { useMyWidget } from './useMyWidget';

export function MyComponent(props) {
  const data = useMyWidget(props);

  // Render based on the data returned by the Hook
  return null;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch } from 'react-instantsearch';
import { MyComponent } from './MyComponent';

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

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

Your new Hook and component can now be used anywhere within <InstantSearch>.

CSS theme

The UI widgets from React InstantSearch are compatible with the default CSS theme.

If you use Hooks and you want to use the default theme in your app, you can follow the markup from the provided UI widgets and use the InstantSearch class names.

Here’s a preview of the theme:

For more information, read the styling and CSS classes guide.

Need help?

React InstantSearch is worked on full-time by Algolia’s JavaScript team.

Join the community

Ask questions and find answers on those following platforms.

• Algolia community forum
• Stack Overflow
• Open and read GitHub issues

Provide feedback

• Write a feature request
• Use the Did you find this page helpful? form below

Stay up to date

• Look at the changelog.

Contributing?

All contributors are welcome, from casual to regular. Feel free to open a pull request.