README.md
September 5, 2024 · View on GitHub
InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React and Vue 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 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 |  | Helper for implementing advanced search features with Algolia |
create-instantsearch-app |  | Command-line utility to quickly bootstrap a project with InstantSearch |
instantsearch.css |  | Default CSS themes for InstantSearch |
instantsearch.js |  | InstantSearch.js |
react-instantsearch |  | React InstantSearch bundled library |
react-instantsearch-core |  | Runtime-independent React InstantSearch version |
vue-instantsearch |  | 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:
- 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)
Please read our contribution process to learn more.
License
InstantSearch is MIT licensed.