<img src="https://yellow-cdn.veclightyear.com/0a4dffa0/d8578e59-2c2f-4297-863e-8e03da7b720a.png" alt="InstantSearch Android" />

InstantSearch 系列：InstantSearch Android | InstantSearch iOS | React InstantSearch | InstantSearch.js | Angular InstantSearch | Vue InstantSearch。

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

示例

您可以在我们的示例应用中看到 InstantSearch Android 的实际运行效果，查看所有可用小部件的具体示例。

使用方法

安装 InstantSearch Android

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

implementation "com.algolia:instantsearch-android:$instantsearch_version"

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

<details> <summary><strong>Compose</strong></summary>

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

implementation "com.algolia:instantsearch-compose:$instantsearch_version"

</details> <details> <summary><strong>Paging 3</strong></summary>

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

implementation "com.algolia:instantsearch-android-paging3:$instantsearch_version"

</details> <details> <summary><strong>Insights</strong></summary>

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

implementation "com.algolia:instantsearch-insights-android:$instantsearch_version"

请参阅库以获取更多详细信息。

</details>

要求

• Kotlin 1.6+
• Android SDK 21+
• Java 8+

R8 / Proguard 规则

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

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

遥测

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

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

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

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

Telemetry.shared.enabled = false

贡献

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

故障排除

遇到问题？在联系支持之前，我们建议您查看我们的 FAQ，其中包含有关库最常见问题和陷阱的解答。

许可证

InstantSearch Android 采用 Apache V2 许可。