getServerState()

Signature

getServerState(<App />)

See code examples

About this function

getServerState() is the function that retrieves the server state to pass to <InstantSearchSSRProvider>.

This function is available from the companion react-instantsearch-hooks-server package.

Guide Server-Side Rendering with React InstantSearch Hooks

Examples

Copy

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

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-hooks-web';

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

Check the server-side rendering example for full markup.

Parameters


            children

type: React.ReactNode

The part of the app that renders <InstantSearch>.

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

Returns

Promise


            serverState

type: InstantSearchServerState

The server state to pass to <InstantSearchSSRProvider>.

Copy
type InitialResult = {
  state: SearchParameters;
  results: SearchResults;
};

type InitialResults = Record<string, InitialResult>;

type InstantSearchServerState = {
  initialResults: InitialResults;
};

Did you find this page helpful?

getServerState()

About this function

Examples

Parameters

Returns Promise

On this page

Returns

Promise