Ein Unterpaket der AlgoliaSearch-Bibliothek, das suchspezifische Funktionen für verbesserte Suche und Entdeckung in Dart/Flutter-Anwendungen bereitstellt.
Aus öffentlichen Paketdaten erstellte Orientierung.
Das Paket algolia_client_search ist eine Dart/Flutter-Bibliothek, die entwickelt wurde, um die leistungsstarken Such- und Entdeckungsfunktionen von Algolia in Anwendungen zu integrieren. Es bietet eine saubere, typensichere API zum Durchführen von Suchanfragen, Verwalten von Indizes und Behandeln der Autovervollständigung über mehrere Plattformen hinweg. Als Teil des AlgoliaSearch-Ökosystems ermöglicht es Entwicklern, schnelle, relevante und skalierbare Sucherfahrungen in Flutter-Anwendungen bereitzustellen. Das Paket unterstützt Echtzeit-Ergebnisse, Faceting und anpassbare Rangfolgen und ist daher ideal für E-Commerce, Inhaltsentdeckung und App-Navigation.
Anwendungsfälle
E-Commerce-Produktsuche
Inhaltserkundung in Apps
Echtzeit-Vervollständigung
benutzergetriebene Filterung
App-Navigation mit Suche
Dynamische Inhaltsindizierung
Hauptmerkmale
Schnelle, skalierbare Suche
Facettensuche unterstützt
Autovervollständigung und Tippfehler-Toleranz
Indexverwaltungs-API
Echtzeit-Resultat-Updates
Typensichere Dart-Schnittstelle
Geeignet für
Flutter-Apps mit bedarf starker Suche
Entwickler, die Algolia-Backend verwenden
Apps mit großen Datensätzen
Projekte, die eine sofortige Suche erfordern
Teams, die Entwicklererfahrung priorisieren
Hinweise
Erfordert Algolia-Konto und API-Schlüssel
Beschränkt auf die Infrastruktur von Algolia
Erforderliche Indexkonfiguration
Kann zusätzliche Einstellungen für erweiterte Funktionen erfordern
Abhängig von der Netzwerkverbindung
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
The perfect starting point to integrate Algolia within your Dart project
algoliasearch is a comprehensive Dart package that provides access to Algolia's robust search and insights features. It is an all-in-one solution designed to help you integrate Algolia within your Dart project seamlessly and efficiently.
The package currently offers the following clients:
Search Client: Allows you to leverage Algolia's search capabilities, including instant search results, search-as-you-type, and typo-tolerance.
Insights Client: Enables you to collect events related to your search and discovery experience, providing valuable insights into user behavior. With it, you can unlock powerful features such as recommendations, personalization, and smarter search results.
Search Lite Client: A lighter, search-only version of the library, perfect for projects that require search functionality without the need for features like indexing.
Future updates will include more clients to cover the entirety of Algolia's feature set, providing a complete toolset for building powerful, interactive search experiences in your Dart or Flutter application.
✨ Features
Low-Level HTTP Client: Provides a thin and minimal low-level HTTP client to interact directly with Algolia's API, giving you maximum control over your requests.
Cross-Platform Compatibility: Designed to work seamlessly on both native and web platforms, making it ideal for any Dart project.
Pure Dart Construction: Built with pure Dart for superior performance and maximum compatibility across Dart projects.
💡 Getting Started
Step 1: Add Dependency
To use this package in your project, add it as a dependency:
For Dart projects:
dart pub add algoliasearch
For Flutter projects:
flutter pub add algoliasearch
Step 2: Import the Package
You can now import the Algolia API client in your project and play with it.
import'package:algolia_client_search/algolia_client_search.dart';
// Alternatively, you can import `algoliasearch_lite`, a **search-only** version of the library, if you do not need the full feature set:// import 'package:algoliasearch/algoliasearch_lite.dart';final client = SearchClient(appId: 'YOUR_APP_ID', apiKey: 'YOUR_API_KEY');
// Add a new record to your Algolia indexfinal response = await client.saveObject(
indexName: "<YOUR_INDEX_NAME>",
body: {
'objectID': "id",
'test': "val",
},
);
// Poll the task status to know when it has been indexedawait client.waitTask('<YOUR_INDEX_NAME>', response.taskID);
// Fetch search results, with typo tolerancefinal response = await client.search(
searchMethodParams: SearchMethodParams(
requests: [
SearchForHits(
indexName: "<YOUR_INDEX_NAME>",
query: "<YOUR_QUERY>",
hitsPerPage: 50,
),
],
),
);
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
Contributing
This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.
📄 License
The Algolia Dart API Client is an open-sourced software licensed under the MIT license.