instantsearch android

Семейство InstantSearch: InstantSearch Android | Мгновенный поиск iOS | Реагировать на мгновенный поиск | InstantSearch.js | Угловой мгновенный поиск | Вю Мгновенный поиск.

InstantSearch Android — это библиотека, предоставляющая виджеты и помощники, которые помогут вам создать лучший способ мгновенного поиска на Android с помощью Algolia. Он построен на основе клиента API Kotlin от Algolia и предоставляет вам высокоуровневое решение для быстрого создания различных поисковых интерфейсов.

Примеры

Вы можете увидеть InstantSearch Android в действии в нашем приложении с примерами. Посмотрите на него, чтобы увидеть конкретные примеры всех доступных виджетов.

Использование

Установка InstantSearch Android

Вы можете добавить InstantSearch в свое приложение Android, добавив следующую строку в зависимости build.gradle:

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

Пожалуйста, следуйте руководству по миграции, чтобы перейти с 2.x на последнюю версию.
▶️ См. документацию. Вы можете начать с Руководства по началу работы.

Сочинить

Вы можете добавить поддержку Compose UI, добавив следующую строку в зависимости build.gradle:

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

Пейджинг 3

Вы можете добавить поддержку Paging 3, добавив следующую строку в зависимости build.gradle:

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

Информация

Вы можете добавить InstantSearch Insights в свое приложение Android, добавив следующую строку в зависимости build.gradle .

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

Пожалуйста, обратитесь в библиотеку для получения более подробной информации.

Требования

• Котлин 1.6+
• Android SDK 21+
• Ява 8+

Правила R8 / Прогард

Если вы используете эту библиотеку в проекте Android, использующем R8, вам ничего не нужно делать. Конкретные правила уже включены в JAR, который R8 может интерпретировать автоматически.

Однако если вы не используете R8, вам могут понадобиться правила из клиента Algolia Kotlin, который является зависимостью этой библиотеки.

Телеметрия

InstantSearch Android собирает данные во время выполнения. Это помогает команде InstantSearch улучшать и определять приоритеты будущего развития.

Вот исчерпывающий список собранных данных:

• Версия мгновенного поиска
• Имя созданных компонентов InstantSearch, например HitsSearcher , FilterState
• Имя компонентов с пользовательскими параметрами (переопределенные значения по умолчанию). InstantSearch не собирает значения этих параметров. Например, значение facets в FacetListInteractor по умолчанию представляет собой пустой список. Если вы создаете его экземпляр со списком фасетов, телеметрия отслеживает, что параметр facets получил пользовательское значение, но не само значение.

InstantSearch не собирает никаких конфиденциальных или личных данных. Однако вы все равно можете отказаться от сбора телеметрии с помощью следующего кода:

 Telemetry .shared.enabled = false 

Содействие

От сообщения об ошибках или недостающей функциональности до исправления опечатки или предложения улучшения — любой вклад приветствуется! Прочтите Руководство для участников, чтобы настроить среду разработки.

Поиск неисправностей

Возникла проблема? Прежде чем обращаться в службу поддержки, мы рекомендуем зайти в раздел часто задаваемых вопросов, где вы найдете ответы на наиболее распространенные проблемы и ошибки, связанные с библиотекой.

Лицензия

InstantSearch Android распространяется под лицензией Apache V2.