Table of Contents generated with DocToc
react-instantsearch-hooks
React InstantSearch Hooks is an open-source UI library for React that lets you quickly build a search interface in your front-end application.
InstantSearch’s goal is to help you implement awesome search experiences as smoothly as possible by providing a complete search ecosystem. InstantSearch tackles an important part of this vast goal by providing front-end primitives that you can assemble into unique search interfaces.
Note: react-instantsearch-hooks
exports renderless components and hooks which can be used for both web and React Native. If you are using React in a web project, we recommend using the package react-instantsearch-hooks-web
instead, as it includes complete components that render to the DOM.
Installation
React InstantSearch Hooks is available on the npm registry. It relies on algoliasearch
to communicate with Algolia APIs.
yarn add algoliasearch react-instantsearch-hooks
npm install algoliasearch react-instantsearch-hooks
Getting started
React InstantSearch Hooks is a headless React library that lets you create an instant search results experience using Algolia’s search API.
Check out our Getting Started guide to start implementing a full-featured search experience with React InstantSearch Hooks.
API reference
Check out the API reference.
Documentation
The documentation is available on algolia.com/doc.
Contributing
We welcome all contributors, from casual to regular 💙
To start contributing to code, you need to:
- Fork the project
- Clone the repository
- Install the dependencies:
yarn
Please read our contribution process to learn more.
License
React InstantSearch Hooks is MIT licensed.