instantsearch android

InstantSearch 系列： InstantSearch Android |即时搜索 iOS |反应即时搜索 |即时搜索.js | Angular 即时搜索 | Vue 即时搜索。

InstantSearch Android是一个提供小部件和帮助程序的库，可帮助您使用 Algolia 在 Android 上构建最佳的即时搜索体验。它构建在 Algolia 的 Kotlin API 客户端之上，为您提供快速构建各种搜索界面的高级解决方案。

示例

您可以在我们的示例应用程序中看到 InstantSearch Android 的运行情况，查看它以查看所有可用小部件的具体示例。

用法

安装 Android 即时搜索

您可以通过将以下行添加到 build.gradle 的依赖项中，将 InstantSearch 添加到您的 Android 应用程序中：

implementation " com.algolia:instantsearch-android: $i nstantsearch_version "

请按照迁移指南从2.x迁移到最新版本。
▶️请参阅文档。您可以从入门指南开始。

撰写

您可以通过将以下行添加到 build.gradle 的依赖项来添加 Compose UI 支持：

implementation " com.algolia:instantsearch-compose: $i nstantsearch_version "

寻呼3

您可以通过将以下行添加到 build.gradle 的依赖项来添加 Paging 3 支持：

implementation " com.algolia:instantsearch-android-paging3: $i nstantsearch_version "

见解

您可以通过将以下行添加到build.gradle的依赖项，将InstantSearch Insights添加到您的 Android 应用程序。

implementation " com.algolia:instantsearch-insights-android: $i nstantsearch_version "

详情请参阅图书馆。

要求

• 科特林 1.6+
• 安卓 SDK 21+
• Java 8+

R8 / Proguard 规则

如果您在使用 R8 的 Android 项目中使用此库，则无需执行任何操作。具体规则已经捆绑到JAR中，R8可以自动解释它。

但是，如果您不使用 R8，那么您可能需要来自 Algolia Kotlin Client 的规则，这是该库的依赖项。

遥测

InstantSearch Android 在运行时收集数据点。这有助于 InstantSearch 团队改进并优先考虑未来的开发。

以下是所收集数据的详尽列表：

• 即时搜索版本
• 实例化的 InstantSearch 组件的名称，例如HitsSearcher 、 FilterState
• 具有自定义参数的组件的名称（覆盖默认值）。 InstantSearch 不收集这些参数的值。例如， FacetListInteractor中的facets值的默认值是一个空列表。如果您使用构面列表实例化它，则遥测会跟踪facets参数收到的自定义值，而不是值本身。

InstantSearch 不会收集任何敏感或个人数据。但是，您仍然可以使用以下代码选择退出遥测收集：

 Telemetry .shared.enabled = false 

贡献

从报告错误或缺失的功能到修复拼写错误或提出改进建议，欢迎所有贡献！阅读贡献指南来设置您的开发环境。

故障排除

遇到问题？在寻求支持之前，我们建议您先查看我们的常见问题解答，您可以在其中找到有关库的最常见问题和陷阱的答案。

执照

InstantSearch Android 在 Apache V2 下获得许可。