API Reference / React InstantSearch Hooks / simple

simple

Signature 
const stateMapping = simple()
Import
Copy 
1

import { simple } from 'instantsearch.js/es/lib/stateMappings';
See code examples

About this function

The simple state mapping is used by default within <InstantSearch>.

The only transformation applied by the function is the omission of configure.

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

import { simple } from 'instantsearch.js/es/lib/stateMappings';

const stateMapping = simple();

stateMapping.stateToRoute({
  instant_search: {
    query: 'Apple',
    page: 5,
    configure: {
      hitsPerPage: 4,
    },
  },
});

// gives as output:
// {
//   instant_search: {
//     query: 'Apple',
//     page: 5,
//   },
// }

Examples

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import { InstantSearch } from 'react-instantsearch-hooks-web';
import { simple } from 'instantsearch.js/es/lib/stateMappings';

const routing = {
  stateMapping: simple(),
};

function App() {
  return (
    <InstantSearch
      searchClient={searchClient}
      indexName="instant_search"
      routing={routing}
    >
      {/* ... */}
    </InstantSearch>
  );
}
Did you find this page helpful?
React InstantSearch Hooks v6