react-instantsearch-hooks

⚡ Lightning-fast search for React, by Algolia

Usage no npm install needed!

<script type="module">
  import reactInstantsearchHooks from 'https://cdn.skypack.dev/react-instantsearch-hooks';
</script>

README

react-instantsearch-hooks

🚧 This version is not yet production-ready.

React InstantSearch Hooks is an open-source, experimental 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.

Edit on CodeSandbox

Installation

React InstantSearch Hooks is available on the npm registry. It relies on algoliasearch to communicate with Algolia APIs.

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

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.

Troubleshooting

React InstantSearch Hooks is an experimental library, and might contain bugs. 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. You are only one command away to start the developer environment, read our CONTRIBUTING guide.

License

React InstantSearch Hooks is MIT licensed.