AEM コンポーネントの開発

AEM コンポーネントを使用して、web ページ上で使用できるコンテンツを保持、書式設定およびレンダリングします。

  • ページをオーサリングするとき、作成者はコンポーネントを使用してコンテンツを編集および設定できます。

    • コマースサイトを構築するときは、コンポーネントを使用して、例えばカタログの情報を収集してレンダリングできます。詳しくは、e コマースの開発を参照してください。

    • コミュニティサイトを構築するときは、コンポーネントを使用して、訪問者に情報を提供したり、訪問者から情報を収集したりできます。詳しくは、コミュニティの開発を参照してください。

  • パブリッシュインスタンスでは、コンポーネントはコンテンツをレンダリングし、Web サイト訪問者に対して必要に応じて表示します。

メモ

このページの内容は、AEM コンポーネント - 基本を踏まえたものです。

注意

/libs/cq/gui/components/authoring/dialog の下にあるコンポーネントは、エディター（オーサリングのコンポーネントダイアログ）で使用することのみが意図されています。他の場所（例えば、ウィザードのダイアログなど）で使用されている場合は、期待どおりに動作しない可能性があります。

コードサンプル

このページには、AEMの新しいコンポーネントの開発に必要なリファレンスドキュメント（またはリファレンスドキュメントへのリンク）が記載されています。 実践的な例については、AEM コンポーネントの開発 - コードサンプルを参照してください。

構造

コンポーネントの基本構造については、AEM コンポーネント - 基本のページで説明しています。このドキュメントでは、タッチ対応 UI とクラシック UI の両方を扱っています。新しいコンポーネントでクラシック設定を使用する必要がない場合でも、既存のコンポーネントから継承する際にクラシック設定について知っていると役立ちます。

既存のコンポーネントとダイアログの拡張

実装するコンポーネントに応じて、全体を定義して開発するのではなく、既存のインスタンスを拡張またはカスタマイズできる場合があります 構造 最初から

既存のコンポーネントまたはダイアログを拡張またはカスタマイズする場合、変更を加える前に、構造全体またはダイアログに必要な構造をコピーまたは複製できます。

既存のコンポーネントの拡張

既存のコンポーネントの拡張は、 リソースタイプ階層 関連する継承メカニズム

メモ

コンポーネントは、検索パスロジックに基づいたオーバーレイを使用して再定義することもできます。ただし、この場合、 Sling Resource Merger がトリガーされず、 /apps はオーバーレイ全体を定義する必要があります。

メモ

この コンテンツフラグメントコンポーネント また、カスタマイズや拡張も可能ですが、Assets との完全な構造と関係を考慮する必要があります。

既存のコンポーネントダイアログのカスタマイズ

Sling Resource Merger を使用し、sling:resourceSuperType プロパティを定義することで、コンポーネントダイアログ​をオーバーライドすることもできます。

つまり、ダイアログ全体を（sling:resourceSuperType を使用して）再定義するのとは対照的に、再定義する必要があるのは相違点だけです。これは、推奨されるコンポーネントダイアログ拡張方法です。

詳しくは、Sling Resource Merger を参照してください。

マークアップの定義

コンポーネントは HTML を使用してレンダリングされます。コンポーネントでは、必要なコンテンツを取得して、オーサリング環境とパブリッシュ環境の両方で必要に応じてレンダリングするために必要な HTML を定義しなければなりません。

HTML テンプレート言語の使用

この HTMLテンプレート言語 (HTL)AEM 6.0 で導入されたは、JSP(JavaServer Pages) の代わりに、HTML用の優先かつ推奨されるサーバー側テンプレートシステムとして使用されます。 堅牢なエンタープライズ Web サイトを構築する必要がある Web 開発者にとって、HTL は、セキュリティと開発の効率を高めるのに役立ちます。

メモ

HTL と JSP の両方をコンポーネントの開発に使用できますが、AEMの推奨スクリプティング言語は HTL なので、このページでは HTL を使用した開発について説明します。

コンテンツロジックの開発

このオプションのロジックでは、レンダリングするコンテンツを選択または計算します。 適切な Use-API パターンを使用して HTL 式から呼び出されます。

ロジックを外観と切り離すメカニズムは、特定のビューに対して何が呼び出されるかを明確にするのに役立ちます。 また、同じリソースのビューが異なると、異なるロジックを使用できます。

Java の使用

HTL Java Use-API を使用すると、HTL ファイルからカスタム Java クラスのヘルパーメソッドへのアクセスが可能になります. これにより、Java コードを使用して、コンポーネントコンテンツの選択と設定のロジックを実装できます。

JavaScript の使用

HTL JavaScript Use-API を使用すると、HTL ファイルから JavaScript で記述されたヘルパーコードへのアクセスが可能になります. そのため、JavaScript コードを使用して、コンポーネントのコンテンツを選択および設定するためのロジックを実装できます。

クライアント側HTMLライブラリの使用

最新の Web サイトは、複雑な JavaScript や CSS コードを利用したクライアント側の処理に大きく依存しています。 このコードの提供を編成および最適化することが厄介な問題となることがあります。

この問題への対処に役立つように、AEM では、クライアント側ライブラリフォルダー​が提供されています。これにより、クライアント側コードをリポジトリに格納し、カテゴリ別に整理して、それぞれのカテゴリのコードをクライアントに提供するタイミングと方法を定義することができます。その後、クライアント側ライブラリシステムにより、最終的な web ページで、正しいコードを読み込むための正しいリンクが作成されます。

読み取り クライアント側HTMLライブラリの使用 を参照してください。

編集動作の設定

コンポーネントの編集動作を設定できます。コンポーネントで使用できるアクションなどの属性、インプレースエディターの特性、コンポーネント上のイベントに関連するリスナーなどが含まれます。 この設定は、特定の違いはあるものの、タッチ操作対応 UI とクラシック UI の両方に共通です。

タイプ cq:EditConfig の cq:editConfig ノードをコンポーネントノード（タイプ cq:Component）の下に追加し、特定のプロパティと子ノードを追加することによって、コンポーネントの編集動作が設定されます。

プレビュー動作の設定

プレビュー​モードに切り替えると、ページが更新されなくても WCM モード Cookie が設定されます。

レンダリングが WCM モードの影響を受けるコンポーネントの場合は、明確にそのコンポーネントを更新し、この Cookie の値を使用するように定義する必要があります。

メモ

値 EDIT と PREVIEW は、タッチ操作対応 UI でのみ WCM モード Cookie に使用されます。

ダイアログの作成と設定

作成者はダイアログを使用してコンポーネントとやり取りできます。ダイアログを使用することで、作成者や管理者はコンテンツを編集したり、コンポーネントを設定したり、（デザインダイアログを使用して）デザインパラメーターを定義したりできます。

Coral UI と Granite UI

Coral UI および Granite UI AEMの最新のルックアンドフィールを定義する。

Granite UI には、様々な基本コンポーネント（ウィジェット）が用意されています オーサリング環境でダイアログを作成するために必要です。 必要に応じて、この選択を拡張し、 独自のウィジェットを作成.

詳しくは、以下を参照してください。

メモ

Granite UI コンポーネントの性質（および ExtJS ウィジェットとの違い）により、タッチ操作対応 UI と クラシック UI.

新しいダイアログの作成

タッチ操作対応 UI 用のダイアログ：

  • cq:dialog という名前です。

  • sling:resourceType プロパティが設定された nt:unstructured ノードとして定義されます。

  • cq:Component ノードの下のコンポーネント定義の横にあります。

  • コンテンツ構造と sling:resourceType プロパティに基づいて、サーバーサイドに（Sling コンポーネントとして）レンダリングされます。

  • Granite UI フレームワークを使用します。

  • には、ダイアログ内のフィールドを記述するノード構造が含まれます。

    • これらのノードは、必須の sling:resourceType プロパティを持つ nt:unstructured ノードです。

ノード構造の例は次のとおりです。

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

ダイアログのカスタマイズは、ダイアログ自体がコンポーネントなので、コンポーネントの開発に似ています（コンポーネントスクリプトでレンダリングするマークアップや、クライアントライブラリで提供する動作やスタイルなど）。

例については、以下を参照してください。

  • /libs/foundation/components/text/cq:dialog
  • /libs/foundation/components/download/cq:dialog
メモ

タッチ操作対応 UI 用のダイアログがコンポーネントに定義されていない場合、クラシック UI ダイアログが互換性レイヤー内のフォールバックとして使用されます。 そのようなダイアログをカスタマイズするには、クラシック UI ダイアログをカスタマイズする必要があります。詳しくは、クラシック UI 用の AEM コンポーネントを参照してください。

ダイアログフィールドのカスタマイズ

メモ

次を参照してください。

新しいフィールドの作成

タッチ操作対応 UI のウィジェットは、Granite UI コンポーネントとして実装されています。

タッチ操作対応 UI 用のコンポーネントダイアログで使用する新しいウィジェットを作成するには、次の手順を実行する必要があります。 新しい Granite UI フィールドコンポーネントを作成します。.

メモ

Granite UI の詳細については、 Granite UI ドキュメント.

ダイアログをフォーム要素の単純なコンテナと見なす場合、ダイアログコンテンツの主なコンテンツをフォームフィールドとして表示することもできます。 新しいフォームフィールドを作成するには、リソースタイプを作成する必要があります。これは、新しいコンポーネントの作成と同じです。 この作業を容易にするために、Granite UI は、sling:resourceSuperType を使用して以下を継承する汎用フィールドコンポーネントを提供しています。

/libs/granite/ui/components/coral/foundation/form/field

Granite UI には、具体的に言えばダイアログ（一般的に言えばフォーム）での使用に適した、幅広いフィールドコンポーネントが用意されています。

メモ

この点はクラシック UI とは異なります。クラシック UI では、ウィジェットは cq:Widgets ノードによって表され、各ノードには対応する ExtJS ウィジェットとの関係を確立するための特定の xtype があります。実装の観点では、これらのウィジェットは ExtJS フレームワークによってクライアントサイドでレンダリングされていました。

リソースタイプを作成したら、sling:resourceType プロパティで参照して新しいノードをダイアログに追加することで、フィールドをインスタンス化できます。

スタイルおよび動作用のクライアントライブラリの作成

コンポーネントのスタイル設定と動作を定義する場合は、カスタム CSS/LESS および JS を定義する専用のクライアントライブラリを作成できます。

クライアントライブラリをコンポーネントダイアログ専用に読み込む（すなわち、別のコンポーネント用には読み込まれないようにする）には、ダイアログの extraClientlibs**​ ** プロパティを、作成したクライアントライブラリのカテゴリ名に設定する必要があります。この方法は、クライアントライブラリが非常に大きい場合や、フィールドがそのダイアログに固有で、他のダイアログで必要になることがない場合にお勧めです。

クライアントライブラリをすべてのダイアログ用に読み込むには、クライアントライブラリのカテゴリプロパティを cq.authoring.dialog に設定します。これは、すべてのダイアログをレンダリングする際にデフォルトで含まれるクライアントライブラリのカテゴリ名です。 クライアントライブラリが小さく、フィールドが汎用で、他のダイアログで再利用できる場合に、この方法を使用します。

例えば、次を参照してください。

フィールドの拡張（継承）

要件に応じて、次のいずれかを実行できます。

  • 指定された Granite UI フィールドをコンポーネントの継承（sling:resourceSuperType）で拡張する
  • ウィジェットライブラリ API（JS/CSS の継承）に従って、基になるウィジェットライブラリ（Granite UI の場合は Coral UI）から特定のウィジェットを拡張する

ダイアログフィールドへのアクセス

レンダリング条件（rendercondition）を使用して、ダイアログ内の特定のタブやフィールドへのアクセス権を持つユーザーを制御することもできます。以下に例を示します。

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

フィールドイベントの処理

ダイアログフィールドのイベントの処理方法は、 カスタムクライアントライブラリのリスナー. これは、以前の方法からの変更です。 コンテンツ構造のリスナー.

カスタムクライアントライブラリのリスナー

フィールドにロジックを挿入するには、以下を実行する必要があります。

  1. 対象となるフィールドを、指定された CSS クラス（フック）でマークします。
  2. クライアントライブラリで、その CSS クラス名にフックされた JS リスナーを定義します（これにより、カスタムロジックがフィールドのみにスコープされ、同じタイプの他のフィールドには影響を与えません）。

これを実現するには、やり取りする、基になるウィジェットライブラリについて理解する必要があります。詳しくは、 Coral UI ドキュメント を使用して、反応するイベントを特定します。 これは、以前に ExtJS で実行する必要があったプロセスと非常に似ています。特定のウィジェットのドキュメントページを見つけ、そのイベント API の詳細を確認します。

例えば、次を参照してください。

コンテンツ構造のリスナー

ExtJS を使用したクラシック UI では、コンテンツ構造内に特定のウィジェットのリスナーを持つのが通常でした。 タッチ操作対応 UI で同じことを実現する方法は、JS リスナーコード（またはコードなど）がコンテンツで定義されなくなったので、異なります。

コンテンツ構造は、セマンティック構造を記述します。基になるウィジェットの性質を暗示してはなりません（必ず）。 コンテンツ構造に JS コードを含めないことで、コンテンツ構造を変更しなくても実装の詳細を変更できます。 つまり、コンテンツ構造にタッチする必要なくウィジェットライブラリを変更できます。

ダイアログの可用性の検出

ダイアログが使用可能で準備が整ったときにのみ実行する必要があるカスタム JavaScript がある場合は、dialog-ready イベントをリッスンする必要があります。

このイベントは、ダイアログが読み込まれて（または再度読み込まれて）、使用の準備ができたときにトリガーされます。つまり、ダイアログの DOM に変更（作成／更新）がある場合に必ずトリガーされます。

dialog-ready は、ダイアログ内のフィールドや類似のタスクをカスタマイズする JavaScript カスタムコードをフックするために使用できます。

フィールドの検証

必須フィールド

特定のフィールドを必須としてマークするには、フィールドのコンテンツノードで次のプロパティを設定します。

  • 名前：required
  • 型：Boolean

例えば、次を参照してください。

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

フィールドの検証 (Granite UI)

Granite UI でのフィールド検証および Granite UI コンポーネント（ウィジェットと同等）のフィールド検証は、foundation-validation API を使用して実行します。詳しくは、foundation-valdiationGranite のドキュメントを参照してください。

詳しくは、例えば、以下を参照してください。

  • cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js

  • /libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js

デザインダイアログの作成と設定

コンポーネントにデザインモードで編集できるデザイン詳細がある場合は、デザインダイアログが表示されます。

デザインダイアログの定義は、コンテンツの編集に使用されるダイアログの定義によく似ています。違いはノードとして定義される点です。

  • ノード名：cq:design_dialog
  • 型：nt:unstructured

インプレースエディターの作成と設定

インプレースエディターを使用すると、ダイアログを開かなくても、段落フロー内のコンテンツを直接編集できます。 例えば、標準のテキストコンポーネントとタイトルコンポーネントには、どちらもインプレースエディターが用意されています。

インプレースエディターは、すべてのコンポーネントタイプに対して必要ではなく、意味もありません。

詳しくは、 ページオーサリングの拡張 — 新しいインプレースエディターの追加 を参照してください。

コンポーネントツールバーのカスタマイズ

この コンポーネントツールバー を使用すると、編集、設定、コピー、削除など、コンポーネントに対する様々なアクションにユーザーがアクセスできます。

詳しくは、 ページオーサリングの拡張 — コンポーネントツールバーに新しいアクションを追加 を参照してください。

参照レールのコンポーネントの設定（借りた/貸した）

新しいコンポーネントが他のページのコンテンツを参照する場合は、 借りたコンテンツ および 貸したコンテンツ セクション 参照 レール。

標準搭載のAEMは、参照コンポーネントのみをチェックします。 コンポーネントを追加するには、OSGi バンドル WCM オーサリングコンテンツ参照設定​を設定する必要があります。

定義に新しいエントリを作成し、確認するプロパティと共にコンポーネントを指定します。次に例を示します。

/apps/<*your-Project*>/components/reference@parentPath

メモ

AEM と連携する場合は、いくつかの方法でこのようなサービスの設定を管理できます。詳細および推奨事項については、OSGi の設定を参照してください。

段落システムへのコンポーネントの有効化と追加

コンポーネントを開発した後、適切な段落システムで使用できるように、必要なページで使用できるようにする必要があります。

これは、次のいずれかの方法で実行できます。

アセットをドラッグするとコンポーネントインスタンスが作成されるように段落システムを設定

AEMでは、次のようにページ上で段落システムを設定できます。 ユーザーが（適切な）アセットをそのページのインスタンスにドラッグすると、新しいコンポーネントのインスタンスが自動的に作成されます （常に空のコンポーネントをページにドラッグする必要はありません）。

この動作と、必要なアセットとコンポーネントの関係は、次のように設定できます。

  1. ページデザインの段落定義の下に表示されます。 次に例を示します。

    • /etc/designs/<myApp>/page/par

    新しいノードを作成します。

    • 名前：cq:authoring
    • 型：nt:unstructured

  2. この下に、アセットとコンポーネントのマッピングをすべて保持する新しいノードを作成します。

    • 名前：assetToComponentMapping
    • 型：nt:unstructured

  3. アセットとコンポーネントのマッピングごとに、ノードを作成します。

    • 名前：テキスト。アセットと関連するコンポーネントタイプを示す名前（例：image）にすることを推奨します。
    • 型：nt:unstructured

    それぞれが以下のプロパティを持ちます。

    • assetGroup：

      • 型：String
      • 値：関連アセットが所属するグループ（例：media）

    • assetMimetype：

      • 型：String
      • 値：関連アセットの MIME タイプ（例：image/*）

    • droptarget：

      • 型：String
      • 値：ドロップターゲット（例：image）

    • resourceType：

      • 型：String
      • 値：関連コンポーネントリソース（例：foundation/components/image）

    • type：

      • 型：String
      • 値：タイプ（例：Images）

例えば、次を参照してください。

  • /etc/designs/geometrixx/jcr:content/page/par/cq:authoring
  • /etc/designs/geometrixx-outdoors/jcr:content/page/par/cq:authoring
  • /etc/designs/geometrixx-media/jcr:content/article/article-content-par/cq:authoring

GitHub のコード

このページのコードは GitHub にあります

メモ

コンポーネントインスタンスの自動作成は、コアコンポーネントと編集可能テンプレートの使用時に UI 内で簡単に設定できるようになりました。特定のメディアタイプに自動的に関連付けるコンポーネントの定義について詳しくは、ページテンプレートの作成を参照してください。

AEM Brackets 拡張の使用

この AEM Brackets Extension は、AEMコンポーネントとクライアントライブラリを編集するためのスムーズなワークフローを提供します。 これは、 Brackets コードエディター。

拡張機能：

  • 同期を容易にして（Maven や File Vault は不要）、開発者の効率を向上させるだけでなく、AEM に関する知識が限られたフロントエンド開発者もプロジェクトに参加できるようにします。
  • コンポーネント開発の単純化やセキュリティ向上のために設計されたテンプレート言語 HTL を一部サポートしています。
メモ

Brackets は、コンポーネントを作成する際に推奨されるメカニズムです。 これは、クラシック UI 用に設計されたCRXDE Lite — コンポーネントを作成機能に代わるものです。

クラシックコンポーネントからの移行

クラシック UI で使用するようにデザインされたコンポーネントを、タッチ操作対応 UI 専用または両方の UI で使用できるコンポーネントに移行する場合は、以下の問題を考慮する必要があります。

cq:listener コードの移行

クラシック UI 向けにデザインされたプロジェクトを移行する場合は、cq:listener コード（およびコンポーネントに関連するクライアント側ライブラリ）でクラシック UI 固有の関数（CQ.wcm.* など）を使用してください。移行するには、タッチ操作対応 UI で同等のオブジェクトまたは関数を使用して、このようなコードを更新する必要があります。

プロジェクトをタッチ操作対応 UI に完全に移行する場合は、タッチ操作対応 UI に関連するオブジェクトや関数を使用するために、このようなコードを置き換える必要があります。

ただし、移行期間中にプロジェクトがクラシック UI とタッチ操作対応 UI の両方に対応する必要がある場合（通常のシナリオ）は、適切なオブジェクトを参照する個別のコードを区別するためのスイッチを実装する必要があります。

このスイッチメカニズムは、次のように実装できます。

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

コンポーネントのドキュメント化

開発者は、次の内容をすばやく理解できるように、コンポーネントドキュメントに簡単にアクセスしたいと考えています。

  • 説明
  • 使用目的
  • コンテンツの構造とプロパティ
  • 公開された API と拡張ポイント
  • その他

このため、コンポーネント内で既存のドキュメントマークダウンを利用できるようにするのは簡単です。

場所 a README.md ファイルを作成します。 この Markdown は、 コンポーネントコンソール.

chlimage_1-7

サポートしているマークダウンは、コンテンツフラグメントの場合と同じです。

このページ