InstantSearch.js

Libraries for building performant and instant search and recommend experiences with Algolia. Compatible with JavaScript, TypeScript, React and Vue.
GitHub
3.73k
Created 9 years ago, last commit 9 hours ago
154 contributors
11.5k commits
Stars added on GitHub, month by month
11
12
1
2
3
4
5
6
7
8
9
10
2023
2024
Stars added on GitHub, per day, on average
Yesterday
+1
Last week
+1.3
/day
Last month
+1.0
/day
Last 12 months
+0.9
/day
npmPackage on NPM
Monthly downloads on NPM
11
12
1
2
3
4
5
6
7
8
9
10
2023
2024
README

InstantSearch.js

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


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

Table of contents

Packages

Package Version Description
algoliasearch-helper algoliasearch-helper npm version Helper for implementing advanced search features with Algolia
create-instantsearch-app create-instantsearch-app npm version Command-line utility to quickly bootstrap a project with InstantSearch
instantsearch.css instantsearch.css npm version Default CSS themes for InstantSearch
instantsearch.js instantsearch.js npm version InstantSearch.js
react-instantsearch react-instantsearch npm version React InstantSearch bundled library
react-instantsearch-core react-instantsearch-core npm version Runtime-independent React InstantSearch version
vue-instantsearch vue-instantsearch npm version Vue InstantSearch

Contributing

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:

  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.