クイック検索コンポーネント(v1) quick-search-component

クイック検索コンポーネントは、Web サイトに検索機能を提供し、検索結果を提示することで、訪問者が一致するコンテンツを簡単に見つけて結果を表示できるようにします。

使用方法 usage

クイック検索コンポーネントを使用すれば、サイト訪問者がコンテンツを検索し、その結果をインプレースで表示し、一致するページに容易に移動できるようになります。ユーザーが検索結果をスクロールすると、それに合わせて新しい結果が動的に取得されます。

編集ダイアログでは、コンテンツツリー内の検索の開始位置をコンテンツ作成者が定義できます。デザインダイアログを使用すれば、コンテンツツリーにおける検索の開始位置のデフォルト値、結果セットサイズの上限、検索語句の長さの下限をテンプレート作成者が設定できます。

バージョンと互換性 version-and-compatibility

このドキュメントでは、クイック検索コンポーネントの現在のバージョン(2018年1月にコアコンポーネントのリリース 2.0.0 で導入された v1)について説明します。

コンポーネントのすべてのサポート対象バージョン、コンポーネントの各バージョンと互換性のある AEM バージョン、以前のバージョンのドキュメントへのリンクを次の表に示します。

コンポーネントのバージョン
AEM 6.4
AEM 6.5
AEM as a Cloud Service
v1
リリース 2.17.4 以前と互換性あり
互換性あり
互換性あり
CAUTION
このドキュメントでは、クイック検索コンポーネント v1 について説明します。
クイック検索コンポーネントの現在のバージョンについて詳しくは、クイック検索コンポーネントのドキュメントを参照してください。

コアコンポーネントのバージョンとリリースについて詳しくは、コアコンポーネントのバージョンを参照してください。

技術的詳細 technical-details

NOTE
DOS 攻撃からの検索コンポーネントや AEM ベースアプリケーションの保護は、Dispatcher で mod_security を使用するなど、より高いレベルで実装する必要があります。

クイック検索コンポーネントに関する最新の技術ドキュメントについては、GitHub を参照してください。

コアコンポーネントの開発について詳しくは、コアコンポーネント開発者向けドキュメントを参照してください。

編集ダイアログ edit-dialog

編集ダイアログでは、コンテンツツリー内の検索の開始位置をコンテンツ作成者が定義できます。

クイック検索コンポーネントの編集ダイアログ

検索ルート - 検索の開始位置となるルートページ。検索ルートは、ブループリントマスター、言語マスター、通常のページのいずれでもかまいません。

  • ID - このオプションを使用すると、HTML 内およびデータレイヤー内のコンポーネントの一意の識別子を制御できます。

    • 空白のままにした場合、一意の ID が自動的に生成されます。生成された ID は結果のページを調べることで確認できます。
    • ID を指定した場合、作者はその ID が一意であることを確認する必要があります。
    • ID を変更すると、CSS、JS、およびデータレイヤーのトラッキングに影響を与える可能性があります。
NOTE
検索ルート ​が設定されていない場合や解決できない場合、クイック検索はデフォルトで現在のページ配下の検索になります。

デザインダイアログ design-dialog

デザインダイアログを使用すれば、コンテンツツリーにおける検索の開始位置のデフォルト値、結果セットサイズの上限、検索語句の長さの下限をテンプレート作成者が設定できます。デザインダイアログでは、コンテンツ作成者が使用できるテキスト書式設定オプションをテンプレート作成者が定義できます。

「プロパティ」タブ properties-tab

クイック検索コンポーネントのデザインダイアログ

  • 検索ルート - コンテンツ作成者がクイック検索コンポーネントをコンテンツページに配置したときの検索ルートのデフォルト値
  • 結果のサイズ - 検索リクエストで取得される結果の最大数
  • 検索語句の最小の長さ - 検索を開始するために使用される検索語句の長さの下限
NOTE
結果のサイズ」と「検索語句の最小の長さ」は、デザインモード(テンプレートレベル)でしか設定できません。つまり、コンテンツ作成者はこれらの値を変更できません。
CAUTION
結果のサイズ」が大きすぎる場合や、「検索語句の最小の長さ」が小さすぎる場合は、パフォーマンスに影響が出る可能性があります。

「スタイル」タブ styles-tab

クイック検索コンポーネントでは、AEM スタイルシステムをサポートしています。

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c