React InstantSearch Core is an open-source UI library for React that lets you quickly build a search interface in your front-end application.
InstantSearch’s goal is to help you implement awesome search experiences as smoothly as possible by providing a complete search ecosystem. InstantSearch tackles an important part of this vast goal by providing front-end primitives that you can assemble into unique search interfaces.
Note:
react-instantsearch-coreexports renderless components and hooks which can be used for both web and React Native. If you are using React in a web project, we recommend using the packagereact-instantsearchinstead, as it includes complete components that render to the DOM.
React InstantSearch Core is available on the npm registry. It relies on algoliasearch to communicate with Algolia APIs.
yarn add algoliasearch react-instantsearch-core
# or
npm install algoliasearch react-instantsearch-coreReact InstantSearch Core is a headless React library that lets you create an instant search results experience using Algolia’s search API.
Check out our Getting Started guide to start implementing a full-featured search experience with React InstantSearch Core.
Check out the API reference.
The documentation is available on algolia.com/doc.
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
Please read our contribution process to learn more.
React InstantSearch is MIT licensed.