InstantSearch.js

A library for building performant and instant search experiences with Algol...

InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React, Vue and Angular with Algolia .

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 , Vue InstantSearch , and Angular InstantSearch .

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

InstantSearch| Angular InstantSearch | InstantSearch Android | InstantSearch iOS

Table of contents

Packages

Contributing

License

Packages

| Package | Version | Description |

| :--- | :--- | :--- |

| create-instantsearch-app| undefined| Command-line utility to quickly bootstrap a project with InstantSearch |

| instantsearch.css| undefined| Default CSS themes for InstantSearch |

| instantsearch.js| undefined| InstantSearch.js |

| react-instantsearch| undefined| React InstantSearch (prefer usingreact-instantsearch-hooks-web instead) |

| react-instantsearch-core| undefined| React InstantSearch Core (prefer usingreact-instantsearch-hooks instead) |

| react-instantsearch-dom| undefined| React InstantSearch DOM (prefer usingreact-instantsearch-hooks-web instead) |

| react-instantsearch-dom-maps| undefined| GeoSearch widget for React InstantSearch DOM |

| react-instantsearch-hooks| undefined| React InstantSearch Hooks |

| react-instantsearch-hooks-server| undefined| Utilities to do server-side rendering with React InstantSearch Hooks |

| react-instantsearch-hooks-web| undefined| React InstantSearch Hooks bundled with UI components |

| react-instantsearch-native| undefined| React InstantSearch Native (prefer usingreact-instantsearch-hooks instead) |

| vue-instantsearch| undefined| Vue InstantSearch |

We welcome all contributors, from casual to regular 💙

Bug report. Is something not working as expected? Send a bug report .

Feature request. Would you like to add something to the library? Send a feature request .

Documentation. Did you find a typo in the doc? Open an issue and we'll take care of it.

Development. If you don't know where to start, you can check the open issues that are tagged easy , the bugs or chores .

To start contributing to code, you need to:

Fork the project

Clone the repository

Install the dependencies: yarn

Pick a package to work on and cd into it (e.g. cd packages/react-instantsearch-hooks)

Please read our contribution process to learn more.

InstantSearch is MIT licensed .