API Reference / InstantSearch.js / stats

stats

A
Signature 
instantsearch.widgets.stats({
  container: string|HTMLElement,
  // Optional parameters
  templates: object,
  cssClasses: object,
});
See code examples
See live example

About this widget # A

The stats widget displays the total number of matching hits and the time it took to get them (time spent in the Algolia server).

Examples # A

Copy 
1
2
3

instantsearch.widgets.stats({
  container: '#stats',
});

Options # A

container #
type: string|HTMLElement
Required

The CSS Selector or HTMLElement to insert the widget into.
Copy 
1
2
3

instantsearch.widgets.stats({
  container: '#stats',
});
templates #
type: object
Optional

The templates to use for the widget.
Copy 
1
2
3
4
5
6

instantsearch.widgets.stats({
  // ...
  templates: {
    // ...
  }
});
cssClasses #
type: object
default: {}
Optional

The CSS classes to override.

  • root: the root element of the widget.
  • text: the text element.
Copy 
1
2
3
4
5
6
7

instantsearch.widgets.stats({
  // ...
  cssClasses: {
    root: 'MyCustomStats',
    text: ['MyCustomStatsText', 'MyCustomStatsText--subclass'],
  },
});

Templates # A

text #
type: string|function
Optional

The template to use to customize the text. It exposes:

  • hasManyResults: boolean: indicates whether the search has more than one result.
  • hasNoResults: boolean: indicates whether the search has no results.
  • hasOneResult: boolean: indicates whether the search has one result.
  • areHitsSorted: boolean: indicates whether Relevant sort is applied to the result.
  • nbSortedHits: number: the number of sorted hits from Relevant sort.
  • hasManySortedResults: boolean: indicates whether the search has more than one sorted result.
  • hasNoSortedResults: boolean: indicates whether the search has no sorted results.
  • hasOneSortedResults: boolean: indicates whether the search has one sorted result.
  • hitsPerPage: number: maximum number of hits returned per page.
  • nbHits: number: the number of hits matched by the query.
  • nbPages: number: the number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.
  • page: number: the position of the current page (zero-based).
  • processingTimeMS: number: the time the server took to process the request, in milliseconds. This doesn’t include network time.
  • query: string: the query sent to the server.
  • cssClasses: object: same option as the cssClasses parameter provided to the widget.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

instantsearch.widgets.stats({
  // ...
  templates: {
    text: `
      {{#areHitsSorted}}
        {{#hasNoSortedResults}}No relevant results{{/hasNoSortedResults}}
        {{#hasOneSortedResults}}1 relevant result{{/hasOneSortedResults}}
        {{#hasManySortedResults}}{{#helpers.formatNumber}}{{nbSortedHits}}{{/helpers.formatNumber}} relevant results{{/hasManySortedResults}}
        sorted out of {{#helpers.formatNumber}}{{nbHits}}{{/helpers.formatNumber}}
      {{/areHitsSorted}}
      {{^areHitsSorted}}
        {{#hasNoResults}}No results{{/hasNoResults}}
        {{#hasOneResult}}1 result{{/hasOneResult}}
        {{#hasManyResults}}{{#helpers.formatNumber}}{{nbHits}}{{/helpers.formatNumber}} results{{/hasManyResults}}
      {{/areHitsSorted}}
      found in {{processingTimeMS}}ms
    `,
  },
});

HTML output# A

Copy 
1
2
3
4
5
6
7
8
9

<div class="ais-Stats">
  <span class="ais-Stats-text">7,435 relevant results sorted out of 20,337 found in 1ms.</span>
</div>

<!-- or -->

<div class="ais-Stats">
  <span class="ais-Stats-text">20,337 results found in 1ms.</span>
</div>

Customize the UI with connectStats# A

If you want to create your own UI of the stats widget, you can use connectors.

It’s a 3-step process:

// 1. Create a render function
const renderStats = (renderOptions, isFirstRender) => {
  // Rendering logic
};

// 2. Create the custom widget
const customStats = instantsearch.connectors.connectStats(
  renderStats
);

// 3. Instantiate
search.addWidgets([
  customStats({
    // instance params
  })
]);

See code examples

Create a render function#

This rendering function is called before the first search (init lifecycle step) and each time results come back from Algolia (render lifecycle step).

const renderStats = (renderOptions, isFirstRender) => {
  const {
    number hitsPerPage,
    number nbHits,
    boolean areHitsSorted,
    number nbSortedHits,
    number nbPages,
    number page,
    number processingTimeMS,
    string query,
    object widgetParams,
  } = renderOptions;

  if (isFirstRender) {
    // Do some initial rendering and bind events
  }

  // Render the widget
}

Rendering options #

hitsPerPage #
type: number

The maximum number of hits returned per page.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { hitsPerPage } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>${hitsPerPage} hits per page</p>
  `;
};
nbHits #
type: number

The number of hits matched by the query.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { nbHits } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>${nbHits} hits</p>
  `;
};
areHitsSorted #
type: boolean

Indicates whether Relevant sort is applied to the result.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { areHitsSorted } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>You're seeing ${areHitsSorted ? 'relevant' : 'all'} results.</p>
  `;
};
nbSortedHits #
type: number

The number of sorted hits from Relevant sort.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { nbSortedHits, nbHits } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>${nbSortedHits} relevant hit(s) sorted out of ${nbHits}</p>
  `;
};
nbPages #
type: number

The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { nbPages } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>${nbPages} pages</p>
  `;
};
page #
type: number

The position of the current page (zero-based).
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { page, nbPages } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>${page + 1}/${nbPages} pages</p>
  `;
};
processingTimeMS #
type: number

The time the server took to process the request, in milliseconds. This doesn’t include network time.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { processingTimeMS } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <p>Results found in ${processingTimeMS}ms</p>
  `;
};
query #
type: string

The query sent to the server.
Copy 
1
2
3
4
5
6
7

const renderStats = (renderOptions, isFirstRender) => {
  const { query } = renderOptions;

  document.querySelector('#stats').innerHTML = `
    <q>${query}</q>
  `;
};
widgetParams #
type: object

All original widget options forwarded to the render function.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

const renderStats = (renderOptions, isFirstRender) => {
  const { widgetParams } = renderOptions;

  widgetParams.container.innerHTML = '...';
};

// ...

search.addWidgets([
  customStats({
    container: document.querySelector('#stats'),
  })
]);

Create and instantiate the custom widget#

We first create custom widgets from our rendering function, then we instantiate them. When doing that, there are two types of parameters you can give:

  • Instance parameters: they are predefined parameters that you can use to configure the behavior of Algolia.
  • Your own parameters: to make the custom widget generic.

Both instance and custom parameters are available in connector.widgetParams, inside the renderFunction.

const customStats = instantsearch.connectors.connectStats(
  renderStats
);

search.addWidgets([customStats()]);

Full example#

Copy 
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

// Create the render function
const renderStats = (renderOptions, isFirstRender) => {
  const {
    nbHits,
    areHitsSorted,
    nbSortedHits,
    processingTimeMS,
    query,
    widgetParams,
  } = renderOptions;

  if (isFirstRender) {
    return;
  }

  let count = '';

  if (areHitsSorted) {
    if (nbSortedHits > 1) {
      count = `${nbSortedHits} relevant results`;
    } else if (nbSortedHits === 1) {
      count = '1 relevant result';
    } else {
      count = 'No relevant result';
    }
    count += ` sorted out of ${nbHits}`;
  } else {
    if (nbHits > 1) {
      count += `${nbHits} results`;
    } else if (nbHits === 1) {
      count += '1 result';
    } else {
      count += 'no result';
    }
  }

  widgetParams.container.innerHTML = `
    ${count} found in ${processingTimeMS}ms
    ${query ? `for <q>${query}</q>` : ''}
  `;
};

// Create the custom widget
const customStats = instantsearch.connectors.connectStats(renderStats);

// Instantiate the custom widget
search.addWidgets([
  customStats({
    container: document.querySelector('#stats'),
  })
]);
Did you find this page helpful?
InstantSearch.js v4