- JS SDKリファレンス
クエリフック
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
UIコンポーネントは、JS SDKパッケージで利用可能なクエリフックを使ってSitecore Search APIと通信します。このトピックでは、リクエストとクエリ結果を用いてクエリフックパターンを説明し、その後JS SDKで利用可能なさまざまなクエリフックを一覧にします。
Request
マーチャンダイジングウィジェットを埋め込みレンダリングするには、Reactフックを使ってコンポーネントをReactQueryシングルトンにWidgetProviderで接続する必要があります。
SDKは、各マーチャンダイジングウィジェットごとにクエリフックを提供します。以下の表はSDKにおける典型的なクエリフックを示しています:
キー
種類
概要
query
Object
クエリ機能を使う予定です。ナロー結果に追加のリクエスト値を設定できます。
widgetRef
Object
受信データを取るReactコンポーネントを参照してください。
actions
Object
ウィジェットがリクエストを入力するために使うアクションやコールバック。各ウィジェットタイプには独自のリストがあります。
state
Object
検索アルゴリズムで使用されるウィジェットの状態を記述するパラメータ。
queryResult
Object
応答オブジェクトを含みます。ウィジェットはその値しか読み取れません。
クエリ結果
queryResultクエリが実行中または実行後にのみ入力されます。さまざまなステータス値と応答を含みます。
キー
種類
概要
isLoading
ブール値
trueの場合、クエリはデータがなく現在フェッチ中です。
isError
ブール値
trueの場合、クエリはエラーに遭遇しました。
isSuccess
ブール値
trueの場合、クエリは成功し、応答オブジェクトが利用可能です。
isFetching
ブール値
trueの場合、クエリはfetchingであり、バックグラウンドでのfetchingも含まれます。
data
Object
レスポンスオブジェクト。
利用可能なクエリフック
アプリケーション内で以下のクエリフックを使用できます:
JS SDKには、ウィジェットをサポートする二次的なクエリフックも含まれており、例えばウィジェットのリストやパンくずなどがあります。
!注注意事項これらのReactリソースは、あなたの実装に役立ちます:
ウィジェットの動作例を見るには、Search JS SDKとUIコンポーネントパッケージを使って作成された スターターキットのウェブサイト をご覧ください。
GitHubリポジトリをダウンロードまたはフォークできます。