react-instantsearch-hooks-server

Table of Contents generated with DocToc

• react-instantsearch-hooks-server
  • Installation
  • Getting started
  • API reference
  • Documentation
  • Contributing
  • License

react-instantsearch-hooks-server

React InstantSearch Hooks is an open-source, UI library for React that lets you server-side render a search interface.

Server-side rendering (SSR) lets you generate HTML from InstantSearch components on the server. React InstantSearch Hooks is compatible with server-side rendering. The library provides an API that works with any SSR solution.

Installation

React InstantSearch Hooks Server is available on the npm registry.

yarn add react-instantsearch-hooks-server
# or
npm install react-instantsearch-hooks-server

Getting started

React InstantSearch Hooks is compatible with server-side rendering. The library provides an API that works with any SSR solution. You can, for example, use it with an express server or with Next.js.

Check out our Server-side rendering guide to start rendering your React InstantSearch Hooks app on the server.

API reference

• getServerState()
• <InstantSearchSSRProvider>

Documentation

The full documentation is available on algolia.com/doc.

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 Hooks is MIT licensed.