InstantSearch / InstantSearch.js / V3 / API reference

Simple | InstantSearch.js V3 (Deprecated)

This version of InstantSearch.js has been deprecated in favor of the latest version of InstantSearch.js.

Signature

Widget signature 
instantsearch.stateMappings.simple();

About this widget

The simple state mapping is used by default within instantsearch.

The function does not apply any transformations.

Copy 
1
2
3
4
5
6
7
8
9

instantsearch.stateMappings.simple().stateToRoute({
  query: 'Apple',
  page: 5,
});

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

Examples

Copy 
1
2
3
4
5
6

instantsearch({
  // ...
  routing: {
    stateMapping: instantsearch.stateMappings.simple(),
  },
});
Did you find this page helpful?