<Stats>

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.

<Stats
  // Optional parameters
  classNames={object}
  translations={object}
  ...props={ComponentProps<'div'>}
/>

1
import { Stats } from 'react-instantsearch';

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

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

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

1
2
3
4
5
6
<Stats
  // ...
  classNames={{
    root: 'MyStats'
  }}
/>

1
2
3
4
5
6
7
8
9
10
<Stats
  // ...
  translations={{
    rootElementText({ nbHits, processingTimeMS, nbSortedHits, areHitsSorted }) {
      return areHitsSorted && nbHits !== nbSortedHits
      ? `${nbSortedHits!.toLocaleString()} relevant results sorted out of ${nbHits.toLocaleString()} found in ${processingTimeMS.toLocaleString()}ms`
      : `${nbHits.toLocaleString()} results found in ${processingTimeMS.toLocaleString()}ms`;
    }
  }}
/>

1
2
3
4
5
<Stats
  // ...
  className="MyCustomStats"
  title="My custom title"
/>

Hook

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

The useStats() Hook returns APIs.

Usage

First, create your React component:

import { useStats } from 'react-instantsearch';

function CustomStats() {
  const {
    hitsPerPage,
    nbHits,
    areHitsSorted,
    nbSortedHits,
    nbPages,
    page,
    processingTimeMS,
    query,
  } = useStats();

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

Then, render the widget:

<CustomStats />

APIs

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

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
import React from 'react';
import { useStats } from 'react-instantsearch';

function CustomStats() {
  const { nbHits, processingTimeMS, query } = useStats();

  return (
    <span>
      {nbHits.toLocaleString()} results found in{' '}
      {processingTimeMS.toLocaleString()}ms for <q>{query}</q>.
    </span>
  );
}