パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.58.0

algolia_client_search

Dart/Flutterアプリにおける検索と発見の強化を目的とした、AlgoliaSearchライブラリのサブパッケージで、検索固有の機能を提供します。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
4.2万
いいね数
6
Pub ポイント
160

パッケージをインストール

flutter pub add algolia_client_search

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

algolia_client_search パッケージは、Algolia の強力な検索および発見機能をアプリケーションに統合するための Dart/Flutter ライブラリです。検索、インデックスの管理、複数のプラットフォームでの自動補完機能を扱うための明確で型安全な API を提供します。AlgoliaSearch エコシステムの一部として構築されており、Flutter アプリで高速かつ関連性の高いスケーラブルな検索体験を実現できます。リアルタイム結果、ファセット、カスタマイズ可能なランク付けをサポートしており、ECサイト、コンテンツ発見、アプリ内ナビゲーションに最適です。

用途

  • EC商品検索
  • アプリ内のコンテンツ発見
  • リアルタイムの自動補完
  • ユーザー主導のフィルタリング
  • 検索付きのアプリナビゲーション
  • 動的コンテンツインデックス

主な機能

  • 高速でスケーラブルな検索
  • ファセット検索のサポート
  • 自動補完とタイポ耐性
  • インデックス管理 API
  • リアルタイムでの結果の更新
  • 型安全な Dart インターフェース

適している対象

  • 強力な検索が必要なFlutterアプリ
  • Algoliaバックエンドを使用する開発者
  • 大規模なデータセットを含むアプリ
  • インスタント検索を必要とするプロジェクト
  • 開発者体験を最優先とするチーム

注意事項

  • AlgoliaアカウントとAPIキーが必要です
  • Algoliaのインフラストラクチャに制限される
  • 適切なインデックス構成が必要です
  • 高度な機能を利用するには、追加の設定が必要になる場合があります
  • ネットワーク接続に依存

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Algolia for Dart

The perfect starting point to integrate Algolia within your Dart project

Latest version Publisher

Flutter Guide • Community Forum • Stack Overflow • Report a Bug • Support

📚 Description

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 index
final response = await client.saveObject(
  indexName: "<YOUR_INDEX_NAME>",
  body: {
    'objectID': "id",
    'test': "val",
  },
);

// Poll the task status to know when it has been indexed
await client.waitTask('<YOUR_INDEX_NAME>', response.taskID);

// Fetch search results, with typo tolerance
final 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.

カテゴリー

依存関係

依存関係一覧 4 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。