• react-instantsearch-router-nextjs
  • Installation
  • Usage
  • API
  • Troubleshooting
  • Contributing
  • License

react-instantsearch-router-nextjs

This package is a router for React InstantSearch that is compatible with Next.js routing.

⚠️ This function cannot be used in conjunction with getStaticProps(). Use getServerSideProps() or client-side rendering instead.

Installation

yarn add react-instantsearch-router-nextjs
# or with npm
npm install react-instantsearch-router-nextjs

Usage

You need to pass the Next.js router singleton that you can import from next/router.

If you are doing SSR with the getServerState and InstantSearchSSRProvider from react-instantsearch/server, you need to pass the url prop to createInstantSearchRouterNext's serverUrl option :

import singletonRouter from 'next/router';
import { createInstantSearchRouterNext } from 'react-instantsearch-router-nextjs';

export default function Page({ serverState, url }) {
  return (
    <InstantSearchSSRProvider {...serverState}>
      <InstantSearch
        searchClient={searchClient}
        indexName="instant_search"
        routing={{
          router: createInstantSearchRouterNext({
            singletonRouter,
            serverUrl: url,
          }),
        }}
      >
        {/* ... */}
      </InstantSearch>
    </InstantSearchSSRProvider>
  );
}

If you are not doing SSR but only CSR, you can omit the serverUrl option:

import singletonRouter from 'next/router';
import { createInstantSearchRouterNext } from 'react-instantsearch-router-nextjs';

export default function Page() {
  return (
    <InstantSearch
      searchClient={searchClient}
      indexName="instant_search"
      routing={{ router: createInstantSearchRouterNext({ singletonRouter }) }}
    >
      {/* ... */}
    </InstantSearch>
  );
}

Lastly, if you had custom routing logic in your app, you can pass it to the createInstantSearchRouterNext's routerOptions option:

import singletonRouter from 'next/router';
import { createInstantSearchRouterNext } from 'react-instantsearch-router-nextjs';

export default function Page({ serverState, url }) {
  return (
    {/* ... */}
      <InstantSearch
        searchClient={searchClient}
        indexName="instant_search"
        routing={{
          router: createInstantSearchRouterNext({
            singletonRouter,
            serverUrl: url,
            routerOptions: {
              createURL: /* ... */,
              parseURL: /* ... */,
            },
          }),
           // if you are using a custom `stateMapping` you can still pass it :
          stateMapping: /* ... */,
        }}
      >
        {/* ... */}
      </InstantSearch>
    {/* ... */}
  );
}

API

The options are :

• singletonRouter: SingletonRouter: the required Next.js router singleton.
• serverUrl?: string: the URL of the page on the server. Required if you are doing SSR with getServerState and InstantSearchSSRProvider.
• routerOptions?: RouterOptions: the options passed to the history router. See the documentation for more details.

For troubleshooting purposes, some other options are available :

• beforeStart?: (onUpdate: () => void) => void: a function called before the router starts. You can use it to inform InstantSearch to update on router events by calling onUpdate.
• beforeDispose?: () => void: a function called before the router disposes. You can use it to clean up handlers you added in beforeStart.
• beforePopState?: (options: { state: NextHistoryState, ownBeforePopState: BeforePopStateCallback, libraryBeforePopState: BeforePopStateCallback }) => boolean: a function used by the Next.js router to know whether it should trigger SSR when using back/forward buttons. You can use it to override the default one by writing your own logic. The ownBeforePopState is the pre-existing handler that you may have set yourself, and the libraryBeforePopState is the default one from the library.

Troubleshooting

If you're experiencing issues, please refer to the Need help? section of the docs, or open a new issue.

Contributing

We welcome all contributors, from casual to regular 💙

• Bug report. Is something not working as expected? Send a bug report.
• Feature request. Would you like to add something to the library? Send a feature request.
• Documentation. Did you find a typo in the doc? Open an issue and we'll take care of it.
• Development. If you don't know where to start, you can check the open issues that are tagged easy, the bugs or chores.

To start contributing to code, you need to:

1. Fork the project
2. Clone the repository
3. Install the dependencies: yarn

Please read our contribution process to learn more.

License

React InstantSearch is MIT licensed.