API Reference / InstantSearch.js Widgets / history

history

Widget signature 
instantsearch.routers.history({
  // Optional parameters
  windowTitle: function,
  createURL: function,
  parseURL: function,
  writeDelay: number,
});
See code examples

About this widget

You are currently reading the documentation for InstantSearch.js V4. Read our migration guide to learn how to upgrade from V3 to V4. You can still access the V3 documentation for this page.

The history router is the one used by default within instantsearch.

The router provides an API that lets you customize some of its behaviors. To get a sense of what you can do with the API, checkout our dedicated guide on Routing URLs.

Examples

Copy 
1
2
3
4
5
6

instantsearch({
  // ...
  routing: {
    router: instantsearch.routers.history(),
  },
});

Options

windowTitle
type: function
Optional

This function lets you dynamically customize the window title based on the provided routeState. It’s called every time the user refines the UI and the history timer completes.
Copy 
1
2
3
4
5
6
7
8
9
10
11

instantsearch.routers.history({
  windowTitle(routeState) {
    const indexState = routeState.indexName || {}

    if (!indexState.query) {
      return 'MyWebsite - Results page'
    }

    return `MyWebsite - Results for: ${indexState.query}`
  },
});
createURL
type: function
Optional

This function lets you directly change the format of URLs that are created and rendered for the browser URL bar or widgets. It’s called every time instantsearch needs to create a URL. The provided options are:

  • qsModule (object): a module that can parse a query string or stringify an object. You can get more information from the qsModule documentation.
  • location (object): an alias to window.location.
  • routeState (objec): the routeState created by the provided stateMapping. When absent, this is an untouched uiState.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

instantsearch.routers.history({
  createURL({ qsModule, location, routeState }) {
    const { origin, pathname, hash } = location;
    const indexState = routeState['instant_search'] || {};
    const queryString = qsModule.stringify(routeState);

    if (!indexState.query) {
      return `${origin}${pathname}${hash}`;
    }

    return `${origin}${pathname}?${queryString}${hash}`;
  },
});
parseURL
type: function
Optional

This function is responsible for parsing the URL string back into a routeState. It must be customized if you customized the createURL function. It’s called every time a user loads or reloads a page, or when they click on the back or next buttons of the browser. The provided options are:

  • qsModule (object): a query string that parses and stringifies modules. You can get more information from the qsModule documentation.
  • location (function): an alias to window.location.
Copy 
1
2
3
4
5

instantsearch.routers.history({
  parseURL({ qsModule, location }) {
    return qsModule.parse(location.search.slice(1));
  },
});
writeDelay
type: number
default: 400
Optional

This option controls the number of milliseconds the router waits before writing the new URL to the browser. You can think about it this way: “400ms after the last user action, the URL is pushed to the browser”. This helps reduce:

  1. The number of different history entries. If you type “phone”, you don’t want to have 5 history entries and thus have to click 5 times on the back button to go back to the previous search state
  2. The performance overhead of updating the browser URL too often. There are recurring but hard to track performance issues associated with updating the browser URL too often: these issues result from browser extensions reacting to every change.

400ms is a typically a pretty good writeDelay.
Copy 
1
2
3

instantsearch.routers.history({
  writeDelay: 400,
});

Did you find this page helpful?

InstantSearch.js v4