実装のためのReactリソース
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
React用JS SDK
Sitecore Search JS SDK for React and Search UI componentsパッケージ パッケージパッケージには、SearchエクスペリエンスをReactに迅速に統合するために使用できるさまざまなコンポーネント、関数、クエリフック、オブジェクトが含まれていますアプリケーション。次のセクションでは、それらと実装におけるそれらの役割について説明します。
Component
SDKでは、ウィジェットコンポーネントとSearchの間のすべての通信を開始および調整するReactコンポーネントは、componentsと呼ばれます。 WidgetsProviderはそのようなコンポーネントであり、ウィジェット コンポーネントをラップします。実行時に、ReactQueryシングルトン クライアントを作成します。ウィジェットコンポーネントは、ウィジェットコンポーネントに関連付けられたrfk_idを使用して、コンテンツまたはデータのこのシングルトンにフックします。
高次関数
開発者が統合を容易にするために、Sitecore Searchにはすぐに使用できる高次関数がSDKに含まれています。
-
widget - UIコンポーネントをウィジェットコンポーネントに構成します。
-
setWidget - CEC構成に一致するウィジェットコンポーネントを作成します。
-
setWidgetType - 特定のタイプの汎用ウィジェットコンポーネントを作成します。
ウィジェットコンポーネント
このSDKには、setWidgetとwidgetの2つの関数があり、UIコンポーネントをrfkIdとwidget typeを持つウィジェット コンポーネントに変換します。ウィジェットコンポーネントは、クエリフックを使用してデータを要求および受信します。
上記の関数を使用して、UI ComponentsパッケージのヘッドレスUIコンポーネントまたはカスタムUIコンポーネントを使用して構築されたウィジェット コンポーネントを作成する必要があります。SDKには、ウィジェットの種類ごとにクエリ フックが用意されています。
クエリフック
WidgetProviderでReactQueryシングルトンとフックするために、ウィジェットコンポーネントはSDK内のReactフックのいずれかを使用します。ウィジェットコンポーネントもフックを介して入力されます。
次の表では、SDKの一般的なクエリ フックについて説明します。
|
鍵 |
種類 |
形容 |
|---|---|---|
|
actions |
Object |
ウィジェットがリクエストを設定するために使用するアクションまたはコールバック。各ウィジェットタイプには、独自のリストがあります。 |
|
state |
Object |
ウィジェットによって入力されたRequestパラメーター。各ウィジェットタイプには、独自のリストがあります。 |
|
queryResult |
Object |
応答オブジェクトが含まれます。ウィジェットは、その値を読み取ることしかできません。 |
SDKには、ウィジェットをサポートするコンポーネントのデータを取得するために使用できる 補完的なクエリフック も用意されています。たとえば、ウィジェットとパンくずリストの一覧です。
UIコンポーネントCLI
エラーを減らし、IDE内でのみ作業できるようにするために、Search UIコンポーネントCLIを使用できます。CLIを使用すると、IDEターミナルを使用して、UIコンポーネント パッケージのウィジェット テンプレートをアプリケーションに直接レプリケートできます。
UI Components参照は、エンティティタイプ別にコンポーネントをリストします。すべてのウィジェットテンプレートは、TypescriptアプリケーションとJavaScript Reactアプリケーションの両方でCLIを使用して使用できます。
「UIコンポーネントを使用した迅速な開発」チュートリアル シリーズでは、CLIのインストールと使用方法について説明します。
Starter kit
スターターキットのWebサイトは、SDKパッケージとUI Componentsパッケージを使用して構築された機能するミニサイトです。このサイトでは、構築できるさまざまな検索エクスペリエンスを確認できます。GitHubリポジトリからWebサイトをダウンロードしてスターター プロジェクトとして使用するか、リポジトリをフォークして検索エクスペリエンスの背後にあるコードを読み取ることができます。
Sitecore開発者ポータル
Sitecore開発者ポータルは、ツールや情報に直接アクセスできるようにすることで、開発者エクスペリエンスを向上させるために作成されました。ポータルでは、さまざまなビデオをホストしています。