getServerState()

This is the React InstantSearch v7 documentation. React InstantSearch v7 is the latest version of React InstantSearch and the stable version of React InstantSearch Hooks.

If you were using React InstantSearch v6, you can upgrade to v7.

If you were using React InstantSearch Hooks, you can still use the React InstantSearch v7 documentation, but you should check the upgrade guide for necessary changes.

If you want to keep using React InstantSearch v6, you can find the archived documentation.

const serverState = await getServerState(children: ReactNode, {
  renderToString?: (node: ReactElement) => unknown,
})

1
import { getServerState } from 'react-instantsearch';

1
2
3
import { getServerState } from 'react-instantsearch';

const serverState = await getServerState(<App />);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import {
  InstantSearch,
  InstantSearchSSRProvider
} from 'react-instantsearch';

function App({ serverState }) {
  return (
    <InstantSearchSSRProvider {...serverState}>
      <InstantSearch indexName="instant_search" searchClient={searchClient}>
        {/* Widgets */}
      </InstantSearch>
    </InstantSearchSSRProvider>
  );
}

1
const serverState = await getServerState(<App />);

1
2
3
4
5
import { renderToString } from 'react-dom/server';

const serverState = await getServerState(<App />, {
  renderToString,
});

1
2
3
4
5
6
7
8
9
10
type InitialResult = {
  state: SearchParameters;
  results: SearchResults;
};

type InitialResults = Record<string, InitialResult>;

type InstantSearchServerState = {
  initialResults: InitialResults;
};