Home

Awesome

<p align="center"> <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/"> <img alt="InstantSearch.js" src=".github/banner.png"> </a> <p align="center"> InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React and Vue with <a href="https://www.algolia.com/?utm_source=instantsearch.js&utm_campaign=repository">Algolia</a>. </p> </p>

License Build Status

InstantSearch is a JavaScript library that lets you create an instant-search result experience using Algolia’s search API.

There are multiple wrappers for popular frameworks, such as React InstantSearch and Vue InstantSearch.

It is part of the InstantSearch family which is designed for different platforms:

InstantSearch | InstantSearch Android | InstantSearch iOS

<details> <summary><strong>Table of contents</strong></summary> <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- END doctoc generated TOC please keep comment here to allow auto update --> </details>

Packages

PackageVersionDescription
algoliasearch-helperalgoliasearch-helper npm versionHelper for implementing advanced search features with Algolia
create-instantsearch-appcreate-instantsearch-app npm versionCommand-line utility to quickly bootstrap a project with InstantSearch
instantsearch.cssinstantsearch.css npm versionDefault CSS themes for InstantSearch
instantsearch.jsinstantsearch.js npm versionInstantSearch.js
react-instantsearchreact-instantsearch npm versionReact InstantSearch bundled library
react-instantsearch-corereact-instantsearch-core npm versionRuntime-independent React InstantSearch version
vue-instantsearchvue-instantsearch npm versionVue InstantSearch

Contributing

We welcome all contributors, from casual to regular 💙

To start contributing to code, you need to:

  1. Fork the project
  2. Clone the repository
  3. Install the dependencies: yarn
  4. Pick a package to work on and cd into it (e.g. cd packages/react-instantsearch)

Please read our contribution process to learn more.

License

InstantSearch is MIT licensed.

<!-- Badges --> <!-- Links -->