instantsearch android

InstantSearch-Familie: InstantSearch Android | InstantSearch iOS | Reagieren Sie auf InstantSearch | InstantSearch.js | Angular InstantSearch | Vue InstantSearch.

InstantSearch Android ist eine Bibliothek mit Widgets und Helfern, die Ihnen dabei helfen, mit Algolia das beste Sofortsucherlebnis auf Android zu schaffen. Es basiert auf dem Kotlin-API-Client von Algolia und bietet Ihnen eine High-Level-Lösung zum schnellen Erstellen verschiedener Suchschnittstellen.

Beispiele

In unserer Beispiel-App können Sie InstantSearch Android in Aktion sehen. Schauen Sie sich die App an, um konkrete Beispiele aller verfügbaren Widgets zu sehen.

Verwendung

InstantSearch Android installieren

Sie können InstantSearch zu Ihrer Android-Anwendung hinzufügen, indem Sie die folgende Zeile zu den Abhängigkeiten Ihres build.gradle hinzufügen:

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

Bitte folgen Sie der Migrationsanleitung, um von 2.x auf die neueste Version zu migrieren.
▶️ Siehe Dokumentation. Sie können mit dem Leitfaden „Erste Schritte“ beginnen.

Komponieren

Sie können Compose UI-Unterstützung hinzufügen, indem Sie die folgende Zeile zu den Abhängigkeiten Ihres build.gradle hinzufügen:

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

Seite 3

Sie können Paging 3-Unterstützung hinzufügen, indem Sie die folgende Zeile zu den Abhängigkeiten Ihres build.gradle hinzufügen:

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

Einblicke

Sie können InstantSearch Insights zu Ihrer Android-Anwendung hinzufügen, indem Sie die folgende Zeile zu den Abhängigkeiten Ihres build.gradle hinzufügen.

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

Weitere Informationen erhalten Sie in der Bibliothek.

Anforderungen

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

R8 / Proguard-Regeln

Wenn Sie diese Bibliothek in einem Android-Projekt verwenden, das R8 verwendet, müssen Sie nichts tun. Die spezifischen Regeln sind bereits im JAR gebündelt, was von R8 automatisch interpretiert werden kann.

Wenn Sie jedoch nicht R8 verwenden, benötigen Sie möglicherweise Regeln vom Algolia Kotlin Client, der eine Abhängigkeit dieser Bibliothek darstellt.

Telemetrie

InstantSearch Android sammelt Datenpunkte zur Laufzeit. Dies hilft dem InstantSearch-Team, zukünftige Entwicklungen zu verbessern und zu priorisieren.

Hier ist eine vollständige Liste der gesammelten Daten:

• InstantSearch-Version
• Der Name der instanziierten InstantSearch-Komponenten, zum Beispiel HitsSearcher , FilterState
• Der Name der Komponenten mit benutzerdefinierten Parametern (überschriebene Standardwerte). InstantSearch erfasst die Werte dieser Parameter nicht. Beispielsweise ist der Standardwert des facets in FacetListInteractor eine leere Liste. Wenn Sie es mit einer Liste von Facetten instanziieren, verfolgt die Telemetrie, dass der facets einen benutzerdefinierten Wert erhalten hat, nicht jedoch den Wert selbst.

InstantSearch sammelt keine sensiblen oder persönlichen Daten. Sie können die Telemetrieerfassung jedoch weiterhin mit dem folgenden Code deaktivieren:

 Telemetry .shared.enabled = false 

Mitwirken

Von der Meldung von Fehlern oder fehlenden Funktionen über die Behebung eines Tippfehlers bis hin zum Vorschlag einer Verbesserung sind alle Beiträge willkommen! Lesen Sie den Contributing Guide, um Ihre Entwicklungsumgebung einzurichten.

Fehlerbehebung

Sie stoßen auf ein Problem? Bevor Sie sich an den Support wenden, empfehlen wir Ihnen, unsere FAQ zu lesen. Dort finden Sie Antworten auf die häufigsten Probleme und Fallstricke mit der Bibliothek.

Lizenz

InstantSearch Android ist unter Apache V2 lizenziert.