| # 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](https://algolia.com/doc/guides/getting-started/how-algolia-works/#the-full-ecosystem). InstantSearch tackles an important part of this vast goal by providing front-end primitives that you can assemble into unique search interfaces. | |
| <p align="center"> | |
| <a href="https://codesandbox.io/s/github/algolia/react-instantsearch/tree/master/examples/hooks" title="Edit on CodeSandbox"> | |
| <img alt="Edit on CodeSandbox" src="https://codesandbox.io/static/img/play-codesandbox.svg"> | |
| </a> | |
| </p> | |
| > 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`](https://github.com/algolia/algoliasearch-client-javascript) to communicate with Algolia APIs. | |
| ```sh | |
| yarn add algoliasearch react-instantsearch-hooks | |
| # or | |
| 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**](https://algolia.com/doc/guides/building-search-ui/getting-started/react-hooks/) to start implementing a full-featured search experience with React InstantSearch Hooks. | |
| ## API reference | |
| Check out the [**API reference**](https://www.algolia.com/doc/api-reference/widgets/react-hooks/). | |
| ## Documentation | |
| The documentation is available on [algolia.com/doc](https://algolia.com/doc/guides/building-search-ui/what-is-instantsearch/react-hooks/). | |
| ## Contributing | |
| We welcome all contributors, from casual to regular. You are only one command away to start the developer environment, [read our CONTRIBUTING guide](https://github.com/algolia/react-instantsearch/blob/master/CONTRIBUTING.md). | |
| ## License | |
| React InstantSearch Hooks is [MIT licensed](../../LICENSE). | |