instantsearch android

Família InstantSearch: InstantSearch Android | Pesquisa Instantânea iOS | Reaja InstantSearch | InstantSearch.js | Pesquisa instantânea angular | Vue InstantSearch.

InstantSearch Android é uma biblioteca que fornece widgets e auxiliares para ajudá-lo a construir a melhor experiência de pesquisa instantânea no Android com Algolia. Ele é construído sobre o Kotlin API Client da Algolia para fornecer uma solução de alto nível para construir rapidamente várias interfaces de pesquisa.

Exemplos

Você pode ver o InstantSearch Android em ação em nosso aplicativo de exemplos, dê uma olhada nele para ver exemplos concretos de todos os widgets disponíveis.

Uso

Instalando InstantSearch Android

Você pode adicionar InstantSearch ao seu aplicativo Android adicionando a seguinte linha às dependências do build.gradle:

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

Siga o guia de migração para migrar da 2.x para a versão mais recente.
▶️ Veja a documentação. Você pode começar com o Guia de primeiros passos.

Compor

Você pode adicionar suporte à UI do Compose adicionando a seguinte linha às dependências do build.gradle:

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

Paginação 3

Você pode adicionar suporte à Paging 3 adicionando a seguinte linha às dependências do build.gradle:

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

Percepções

Você pode adicionar InstantSearch Insights ao seu aplicativo Android adicionando a seguinte linha às dependências do build.gradle .

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

Consulte a biblioteca para obter mais detalhes.

Requisitos

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

Regras R8/Proguard

Se você usar esta biblioteca em um projeto Android que usa R8, não há nada que você precise fazer. As regras específicas já estão incluídas no JAR, que pode ser interpretado automaticamente pelo R8.

Se, no entanto, você não usar R8, poderá precisar de regras do Algolia Kotlin Client, que é uma dependência desta biblioteca.

Telemetria

InstantSearch Android coleta pontos de dados em tempo de execução. Isso ajuda a equipe do InstantSearch a melhorar e priorizar o desenvolvimento futuro.

Aqui está uma lista exaustiva dos dados coletados:

• Versão do InstantSearch
• O nome dos componentes InstantSearch instanciados, por exemplo, HitsSearcher , FilterState
• O nome dos componentes com parâmetros personalizados (padrões substituídos). InstantSearch não coleta os valores desses parâmetros. Por exemplo, o padrão do valor de facets em FacetListInteractor é uma lista vazia. Se você instanciá-lo com uma lista de facetas, a telemetria rastreará se o parâmetro facets recebeu um valor personalizado, mas não o valor em si.

InstantSearch não coleta dados confidenciais ou pessoais. No entanto, você ainda pode cancelar a coleta de telemetria com o seguinte código:

 Telemetry .shared.enabled = false 

Contribuindo

Desde relatar bugs ou funcionalidades ausentes até corrigir um erro de digitação ou propor uma melhoria, todas as contribuições são bem-vindas! Leia o Guia de Contribuição para configurar seu ambiente de desenvolvimento.

Solução de problemas

Encontrando um problema? Antes de entrar em contato com o suporte, recomendamos acessar nosso FAQ, onde você encontrará respostas para os problemas e pegadinhas mais comuns com a biblioteca.

Licença

InstantSearch Android é licenciado sob Apache V2.