クイック検索コンポーネント quick-search-component
クイック検索コンポーネントは、Web サイトに検索機能を提供し、検索結果を提示することで、訪問者が一致するコンテンツを簡単に見つけて結果を表示できるようにします。
使用方法 usage
クイック検索コンポーネントを使用すれば、サイト訪問者がコンテンツを検索し、その結果をインプレースで表示し、一致するページに容易に移動できるようになります。 ユーザーが検索結果をスクロールすると、それに合わせて新しい結果が動的に取得されます。
編集ダイアログ を使用すると、コンテンツ作成者は、コンテンツツリー内の検索を開始する場所を定義できます。また、オプションでセマンティック検索トグルを非表示にすることもできます。 テンプレート作成者は、 デザインダイアログ を使用して、コンテンツツリー内の検索を開始する場所、最大結果セットサイズ、最小検索語句の長さ、およびセマンティック検索トグルがデフォルトで訪問者に表示されるかどうかに関するデフォルト値を設定できます。
バージョンと互換性 version-and-compatibility
現在のバージョンのクイック検索コンポーネントはv3です。このバージョンは、 リリース 2.32.0のコアコンポーネントにオプションのセマンティック検索トグルが追加されて導入されたもので、このドキュメントで説明します。
コンポーネントのすべてのサポート対象バージョン、コンポーネントの各バージョンと互換性のある AEM バージョン、以前のバージョンのドキュメントへのリンクを次の表に示します。
コアコンポーネントのバージョンとリリースについて詳しくは、コアコンポーネントのバージョンを参照してください。
技術的詳細 technical-details
mod_security を使用するなど、より高いレベルで実装する必要があります。クイック検索コンポーネントに関する最新の技術ドキュメントについては、GitHub を参照してください。
コアコンポーネントの開発について詳しくは、コアコンポーネント開発者向けドキュメントを参照してください。
編集ダイアログ edit-dialog
編集ダイアログでは、コンテンツ作成者がコンテンツツリー内のどこから検索を開始するかを定義し、必要に応じてセマンティック検索トグルを非表示にすることができます。
検索ルート - 検索の開始位置となるルートページ。 検索ルートは、ブループリントマスター、言語マスター、通常のページのいずれでもかまいません。
-
ID - このオプションを使用すると、HTML 内およびデータレイヤー内のコンポーネントの一意の識別子を制御できます。
- 空白のままにした場合、一意の ID が自動的に生成されます。生成された ID は結果のページを調べることで確認できます。
- ID を指定した場合、作者はその ID が一意であることを確認する必要があります。
- ID を変更すると、CSS、JS、およびデータレイヤーのトラッキングに影響を与える可能性があります。
-
このインスタンスでセマンティック検索を非表示トグル – オンにすると、 デザインダイアログ が表示するように設定されているかどうかに関係なく、セマンティック検索トグルが非表示になります。
- テンプレートのデフォルトを使用する場合は、このチェックをオフにします。
- このオプションは、デザインダイアログで非表示になっているプレースメントにトグルを強制的に表示することはできません。
デザインダイアログ design-dialog
デザインダイアログを使用して、テンプレート作成者は、コンテンツツリー内の検索を開始する場所のデフォルト値と、結果セットサイズの最大値、検索語句の最小長、およびセマンティック検索トグルがデフォルトで訪問者に表示されるかどうかを設定できます。
「プロパティ」タブ properties-tab
-
検索ルート - コンテンツ作成者がコンテンツ ページにクイック検索コンポーネントを配置する場合の検索ルートのデフォルト値
-
結果サイズ – 検索リクエストによって取得された結果の最大数
-
検索語句の最小長 – 検索を開始するための検索語句の最小長
-
セマンティック検索の非表示の切り替え - オンにすると、使用状況で説明されている セマンティック検索 の切り替えはデフォルトでサイト訪問者に表示されず、コンポーネントはv2 （フルテキスト検索のみ）コンポーネントのように動作します。
- デフォルトではオフになっています。
- コンテンツ作成者は、編集ダイアログの個々のクイック検索コンポーネントに対してこれを上書きすることもできます。