react-instantsearch
React InstantSearch is an open-source React library that lets you create an instant search result experience using Algolia’s search API. It is part of the InstantSearch family:
React InstantSearch | InstantSearch.js | Angular InstantSearch | Vue InstantSearch | InstantSearch Android | InstantSearch iOS
Why
You should be using React InstantSearch if you want to:
- Design search experiences with best practices
- Customize your components at will
- Follow React principles
Note: If you are working with React Native, or otherwise do not use the DOM, check out react-instantsearch-core
instead.
Installation
React InstantSearch is available on the npm registry. It relies on algoliasearch
to communicate with Algolia APIs.
yarn add algoliasearch react-instantsearch
npm install algoliasearch react-instantsearch
Getting started
Using React InstantSearch is as simple as adding these components to your app:
import React from 'react';
import ReactDOM from 'react-dom';
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch, SearchBox, Hits } from 'react-instantsearch';
const searchClient = algoliasearch(
'latency',
'6be0576ff61c053d5f9a3225e2a90f76'
);
const App = () => (
<InstantSearch indexName="bestbuy" searchClient={searchClient}>
<SearchBox />
<Hits />
</InstantSearch>
);
To learn more about the library, follow the getting started guide.
Documentation
The documentation is available on algolia.com/doc.
Playground
You can get to know React InstantSearch on this playground.
Start by adding components and tweaking the display. Once you get more familiar with the library, you can learn more advanced concepts in our guides.
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 is MIT licensed.