InstantSearch family: InstantSearch Android | InstantSearch iOS | React InstantSearch | InstantSearch.js | Angular InstantSearch | Vue InstantSearch.
InstantSearch Android is a library providing widgets and helpers to help you build the best instant-search experience on Android with Algolia. It is built on top of Algolia's Kotlin API Client to provide you a high-level solution to quickly build various search interfaces.
Usage
You can add InstantSearch to your Android application by adding the following line to your build.gradle's dependencies.
implementation "com.algolia:instantsearch-android:$instantsearch_version"2.4.0, the library is compatible only with kotlin version 1.3.70 or higher; for previous versions of kotlin, please use version 2.3.1 of the library.
2.5.x or below to the latest version.
See the documentation. You can start with the Getting Started Guide.
R8 / Proguard rules
If you use this library in an Android project which uses R8, there is nothing you have to do. The specific rules are already bundled into the JAR, which can be interpreted by R8 automatically.
If however, you don’t use R8, then you might need rules from Algolia Kotlin Client which is a dependency of this library.
Contributing
From reporting bugs or missing functionality to fixing a typo or proposing an improvement, all contributions are welcome! Read the Contributing Guide to setup your development environment.
Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the library.
License
InstantSearch Android is licensed under Apache V2.
