instantsearch iosダウンロード - instantsearch iosソースコードのダウンロード

instantsearch ios

その他のソースコード

7.26.3

ダウンロード

インスタントサーチ iOS

アルゴリア著。

InstantSearch iOS は、 Algolia を使用して iOS 上で最高のインスタント検索エクスペリエンスを構築するのに役立つコンポーネントとヘルパーを提供するフレームワークです。これは、Algolia の Swift API クライアントライブラリの上に構築されており、さまざまな検索インターフェイスを迅速に構築するための高レベルのソリューションを提供します。

構造

InstantSearch iOS は3 つの製品で構成されています

InstantSearch Insights – 開発者が検索関連のイベントをキャプチャできるライブラリ
InstantSearch コア– InstantSearch のビジネスロジックモジュール
InstantSearch – UIKit コンポーネントを含む完全な InstantSearch ツールセット
InstantSearch SwiftUI – コアコンポーネント上で使用する SwiftUI データモデルとビューのセット

例

Examples プロジェクトでは、InstantSearch iOS の動作を確認できます。これには、InstantSearch で構築され、Swift で記述された検索コンポーネントとエクスペリエンスが含まれています。

インストール

Swiftパッケージマネージャー

Swift Package Manager は、Swift コードの配布を管理するためのツールです。 Swift ビルドシステムと統合されており、依存関係のダウンロード、コンパイル、リンクのプロセスを自動化します。 Swift 5 および Xcode 11 のリリース以来、SPM は、アプリを作成するための iOS、macOS、および tvOS ビルドシステムと互換性があります。

SwiftPM を使用するには、Xcode 11 を使用してプロジェクトを開く必要があります。 File ] -> Swift Packages -> Add Package Dependencyをクリックし、InstantSearch リポジトリの URL を入力します。次に、提供されたリストからプロジェクトでの使用を検討している製品を選択します。

あなたがフレームワーク作成者で、依存関係として InstantSearch を使用している場合は、 Package.swiftファイルを更新します。

 let package = Package (
    // 7.26.0 ..< 8.0.0
    dependencies : [
        . package ( url : " https://github.com/algolia/instantsearch-ios " , from : " 7.26.0 " )
    ] ,
    // ...
)

ココアポッド

CocoaPods は、Cocoa プロジェクトの依存関係マネージャーです。

InstantSearch をインストールするには、次の行を Podfile に追加するだけです。

 pod 'InstantSearch' , '~> 7.26'
# pod 'InstantSearch/Insights' for access to Insights library only
# pod 'InstantSearch/Core' for access business logic without UIKit components
# pod 'InstantSearch/SwiftUI' for access to SwiftUI components

次に、次のコマンドを実行します。

$ pod update

カルタゴ

Carthage は、Cocoa 用のシンプルな分散依存関係マネージャーです。

InstantSearch をインストールするには、次の行をカートファイルに追加するだけです。

 github "algolia/instantsearch-ios" ~> 7.26

プロジェクトディレクトリから次のコマンドを起動します。

carthage update
./Carthage/Checkouts/instant-search-ios/carthage-prebuild
carthage build

注: 現時点では、Carthage は特定のリポジトリサブコンポーネント (または CocoaPods のサブ仕様と同等のもの) のみを構築する方法を提供していません。すべてのコンポーネントとその依存関係は、上記のコマンドを使用してビルドされます。ただし、使用していないフレームワークをプロジェクトにコピーする必要はありません。たとえば、 InstantSearchの UI コンポーネントを使用していない場合は、 carthage update完了した後、 InstantSearchCoreだけを残して、Carthage Build ディレクトリからそのフレームワークを自由に削除してください。イベント追跡機能のみが必要な場合は、 InstantSearchInsightsフレームワーク以外のすべてを削除します。

プロジェクトで Carthage を初めて使用する場合は、Carthage で説明されているように、いくつかの追加の手順を実行する必要があります。

ドキュメント

スタートガイドから始めることができます。

instantSearch iOS の詳細については、専用のドキュメント Web サイトをご覧ください。

基本的な使い方

ViewController.swiftで:

import InstantSearch

struct Item : Codable {
  let name : String
}

class SearchResultsViewController : UITableViewController , HitsController {
  
  var hitsSource : HitsInteractor < Item > ?
    
  override func viewDidLoad ( ) {
    super . viewDidLoad ( )
    tableView . register ( UITableViewCell . self , forCellReuseIdentifier : " cell " )
  }
      
  override func tableView ( _ tableView : UITableView , numberOfRowsInSection section : Int ) -> Int {
    hitsSource ? . numberOfHits ( ) ?? 0
  }
  
  override func tableView ( _ tableView : UITableView , cellForRowAt indexPath : IndexPath ) -> UITableViewCell {
    let cell = tableView . dequeueReusableCell ( withIdentifier : " cell " , for : indexPath )
    cell . textLabel ? . text = hitsSource ? . hit ( atIndex : indexPath . row ) ? . name
    return cell
  }
  
  override func tableView ( _ tableView : UITableView , didSelectRowAt indexPath : IndexPath ) {
    if let _ = hitsSource ? . hit ( atIndex : indexPath . row ) {
      // Handle hit selection
    }
  }
  
}

class ViewController : UIViewController {
      
  lazy var searchController = UISearchController ( searchResultsController : hitsViewController )
  let hitsViewController = SearchResultsViewController ( )

  let searcher = HitsSearcher ( appID : " latency " ,
                              apiKey : " 1f6fd3a6fb973cb08419fe7d288fa4db " ,
                              indexName : " bestbuy " )
  lazy var searchConnector = SearchConnector < Item > ( searcher : searcher ,
                                                    searchController : searchController ,
                                                    hitsInteractor : . init ( ) ,
                                                    hitsController : hitsViewController )
  
  override func viewDidLoad ( ) {
    super . viewDidLoad ( )
    searchConnector . connect ( )
    searcher . search ( )
    setupUI ( )
  }
  
  override func viewDidAppear ( _ animated : Bool ) {
    super . viewDidAppear ( animated )
    searchController . isActive = true
  }
  
  func setupUI ( ) {
    view . backgroundColor = . white
    navigationItem . searchController = searchController
    searchController . hidesNavigationBarDuringPresentation = false
    searchController . showsSearchResultsController = true
    searchController . automaticallyShowsCancelButton = false
  }
      
}

これで、アプリケーションを構築して実行し、基本的な検索エクスペリエンスの動作を確認できるようになりました。キーを押すたびに結果が変化していることがわかります。

より有意義な検索エクスペリエンスを得るには、「スタートガイド」に従ってください。 SwiftUI アプリケーションを構築する場合は、「SwiftUI 入門ガイド」を参照してください。

プロジェクトでビジネスロジックモジュールのみが必要で、 InstantSearchCoreフレームワークを使用する場合は、 import InstantSearchCoreソースファイルに追加します。

ログ

ライブラリによって生成されるログの重大度には 7 つのレベルがあります。デフォルトの重大度レベルは.infoです。ログレベルは次のように設定できます。

 Logs.logSeverityLevel = .debug

テレメトリー

InstantSearch iOS は実行時にデータポイントを収集します。これは、InstantSearch チームが将来の開発を改善し、優先順位を付けるのに役立ちます。

収集されたデータの完全なリストは次のとおりです。

インスタントサーチのバージョン
インスタンス化された InstantSearch コンポーネントの名前 (例: HitsSearcher 、 FilterState
カスタムパラメータを持つコンポーネントの名前 (デフォルト値が上書きされます)。 InstantSearch はこれらのパラメーターの値を収集しません。たとえば、 FacetListInteractorのfacets値のデフォルトは空のリストです。ファセットのリストを使用してインスタンス化すると、テレメトリは、 facetsパラメーターがカスタム値を受け取ったことを追跡しますが、値自体は追跡しません。

InstantSearch は機密データや個人データを収集しません。ただし、次のコードを使用してテレメトリ収集をオプトアウトすることもできます。

 InstantSearchTelemetry . shared . isEnabled = false

助けを求める

助けが必要ですか? Algolia コミュニティまたは Stack Overflow に質問してください。
問題が発生しましたか?サポートに連絡する前に、フレームワークに関する最も一般的な問題と注意点に対する回答が記載されている FAQ にアクセスすることをお勧めします。
バグが見つかりましたか? GitHub の問題を開くことができます。
アルゴリアについての質問?弊社 Web サイトで FAQ を検索できます。