instantsearch android

Famille InstantSearch : InstantSearch Android | Recherche instantanée iOS | Réagissez à la recherche instantanée | InstantSearch.js | Recherche instantanée angulaire | Vue InstantSearch.

InstantSearch Android est une bibliothèque fournissant des widgets et des aides pour vous aider à créer la meilleure expérience de recherche instantanée sur Android avec Algolia. Il est construit sur le client API Kotlin d'Algolia pour vous fournir une solution de haut niveau pour créer rapidement diverses interfaces de recherche.

Exemples

Vous pouvez voir InstantSearch Android en action dans notre application d'exemples, jetez-y un œil pour voir des exemples concrets de tous les widgets disponibles.

Usage

Installation d'InstantSearch sur Android

Vous pouvez ajouter InstantSearch à votre application Android en ajoutant la ligne suivante aux dépendances de votre build.gradle :

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

Veuillez suivre le guide de migration pour migrer de 2.x vers la dernière version.
▶️ Voir la documentation. Vous pouvez commencer avec le Guide de démarrage.

Composer

Vous pouvez ajouter la prise en charge de Compose UI en ajoutant la ligne suivante aux dépendances de votre build.gradle :

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

Page 3

Vous pouvez ajouter la prise en charge de Paging 3 en ajoutant la ligne suivante aux dépendances de votre build.gradle :

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

Connaissances

Vous pouvez ajouter InstantSearch Insights à votre application Android en ajoutant la ligne suivante aux dépendances de votre build.gradle .

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

Veuillez vous référer à la bibliothèque pour plus de détails.

Exigences

• Kotlin 1.6+
• SDK Android 21+
• Java8+

R8 / Règles Proguard

Si vous utilisez cette bibliothèque dans un projet Android qui utilise R8, vous n'avez rien à faire. Les règles spécifiques sont déjà regroupées dans le JAR, qui peut être interprété automatiquement par R8.

Si toutefois vous n'utilisez pas R8, vous aurez peut-être besoin des règles d'Algolia Kotlin Client qui est une dépendance de cette bibliothèque.

Télémétrie

InstantSearch Android collecte des points de données au moment de l'exécution. Cela aide l’équipe InstantSearch à améliorer et à prioriser les développements futurs.

Voici une liste exhaustive des données collectées :

• Version de recherche instantanée
• Le nom des composants InstantSearch instanciés, par exemple, HitsSearcher , FilterState
• Le nom des composants avec des paramètres personnalisés (valeurs par défaut remplacées). InstantSearch ne collecte pas les valeurs de ces paramètres. Par exemple, la valeur par défaut de la valeur facets dans FacetListInteractor est une liste vide. Si vous l'instanciez avec une liste de facettes, la télémétrie indique que le paramètre facets a reçu une valeur personnalisée, mais pas la valeur elle-même.

InstantSearch ne collecte aucune donnée sensible ou personnelle. Cependant, vous pouvez toujours vous désinscrire de la collecte de télémétrie avec le code suivant :

 Telemetry .shared.enabled = false 

Contribuer

Qu'il s'agisse de signaler des bugs ou des fonctionnalités manquantes, de corriger une faute de frappe ou de proposer une amélioration, toutes les contributions sont les bienvenues ! Lisez le Guide de contribution pour configurer votre environnement de développement.

Dépannage

Vous rencontrez un problème ? Avant de contacter l'assistance, nous vous recommandons de consulter notre FAQ où vous trouverez des réponses aux problèmes et pièges les plus courants avec la bibliothèque.

Licence

InstantSearch Android est sous licence Apache V2.