Skip to main content
Signature
singleIndex(
  indexName: string,
);

​
Import

import { singleIndex } from "instantsearch.js/es/lib/stateMappings";

​
About this widget

The singleIndex state mapping can be applied to the instantsearch object’s routing option. It enables backward compatibility with version 3.x. The mapping applies the following transformations:
  • Omits the configure widget
  • Uses the given index for the top level
JavaScript
singleIndex("instant_search").stateToRoute({
  instant_search: {
    query: "Apple",
    page: 5,
    configure: {
      hitsPerPage: 4,
    },
  },
});

// {
//   query: 'Apple',
//   page: 5,
// }

​
Examples

JavaScript
instantsearch({
  // ...
  routing: {
    stateMapping: singleIndex("instant_search"),
  },
});

​
Options

​
indexName
string
required
The name of the index to get the state from, usually the same value provided to instantsearch.
JavaScript
singleIndex("instant_search");
⌘I