⚡ Lightning-fast search for React and React Native applications, by Algolia.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore(deps): update circleci/node:8.12.0 docker digest to 09e1035 (#1799 Dec 10, 2018
.github docs(CodeSandbox): link to our CodeSandbox templates … (#870) Jan 18, 2018
docgen chore(deps): update dependency react-hot-loader to v4.6.3 (#1818) Dec 19, 2018
examples chore(deps): update example next js and react to latest deps (#1797) Dec 14, 2018
packages chore(deps): update dependency rollup to v0.68.0 (#1809) Dec 16, 2018
scripts chore(deps): update dependency lerna to v3 (#1492) Aug 16, 2018
stories chore(deps): update dependency prettier to v1.15.2 (#1724) Nov 12, 2018
storybook chore: switch from Travis to CircleCI (#1515) Aug 21, 2018
test/regressions test(e2e): remove GeoSearch it is too brittle (#1367) Jun 23, 2018
.babelrc chore(packages): create core package [PART-1] (#1258) Jun 4, 2018
.editorconfig chore(editorconfig): add config (#437) Oct 9, 2017
.eslintignore chore: enable workspaces on docgen (#1116) Mar 29, 2018
.eslintrc.js chore(deps): update dependency eslint-config-algolia to v13.2.3 (#1532) Aug 28, 2018
.gitignore chore(packages): create core package [PART-1] (#1258) Jun 4, 2018
.happo.js tests(visual): add Argos CI (#130) Jun 22, 2017
.nvmrc chore(deps): update node.js to v8.12.0 (#1569) Sep 14, 2018
.prettierrc chore: add .prettierrc (#829) Jan 12, 2018
AUTHORS docs(AUTHORS): update Feb 15, 2017
CHANGELOG.md v5.3.2 Oct 30, 2018
CONTRIBUTING.md chore(deps): update yarn to v1.12.3 (#1728) Nov 12, 2018
LICENSE chore(react-instantsearch): move to react-instantsearch repo Apr 4, 2017
README.md chore: switch from Travis to CircleCI (#1515) Aug 21, 2018
lerna.json v5.3.2 Oct 30, 2018
netlify.toml chore(deps): update yarn to v1.12.3 (#1728) Nov 12, 2018
package.json chore(deps): update dependency netlify-cli to v2.6.0 (#1815) Dec 18, 2018
renovate.json chore: update Renovate (#1691) Oct 26, 2018
yarn.lock chore(deps): update dependency react-hot-loader to v4.6.3 (#1818) Dec 19, 2018

README.md

React InstantSearch

React InstantSearch is a library for building blazing fast search-as-you-type search UIs with Algolia.


Version Build Status License Downloads

React InstantSearch is a 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

Installation

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

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

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-dom';

const searchClient = algoliasearch(
  'latency',
  '6be0576ff61c053d5f9a3225e2a90f76'
);

const App = () => (
  <InstantSearch
    indexName="bestbuy"
    searchClient={searchClient}
  >
    <SearchBox />
    <Hits />
  </InstantSearch>
);

Edit on CodeSandbox

To learn more about the library, follow the getting started guide.

Documentation

The documentation is available at community.algolia.com/react-instantsearch.

Demos

E-commerce Media Travel
E-commerce demo preview Media demo preview Tourism demo preview

See more examples on the website.

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. You are only one command away to start the developer environment, read our CONTRIBUTING guide.

License

React InstantSearch is MIT licensed.