属性とタイプ attributes-types

ユニバーサルエディターに必要なデータ属性と項目タイプについて説明します。

はじめに introduction

アプリをユニバーサルエディターで編集できるようにするには、アプリのインストルメントを適切に行う必要があります。これには、エディターがアプリのコンテンツを編集できるように、適切なメタデータを含めることが含まれます。このドキュメントでは、これらのメタデータの属性と項目タイプについて詳しく説明します。

NOTE
コンテンツの検証は、サーバーサイドで実行されます。ユニバーサルエディターは単にデータ属性を操作します。モデルや構造に適合するかどうかの検証は、API レベルで対処する必要があります。

データプロパティ data-properties

データプロパティ
説明
data-aue-resource
リソースに対する URN。AEM のユニバーサルエディターを使用した概要ドキュメントページのインストルメントの節を参照してください。
data-aue-prop
リソースの属性。AEM のユニバーサルエディターを使用した概要ドキュメントページのインストルメントの節を参照してください。
data-aue-type
編集可能な項目のタイプ(テキスト、画像、参照など)
data-aue-filter
どの参照が使用できるかをを定義します
data-aue-label
エディターに表示される選択可能な項目のカスタムラベルを定義します。
data-aue-model が設定されている場合、ラベルはモデルを使用して取得されます
data-aue-model
プロパティパネルでフォームベースの編集に使用するモデルを定義します
data-aue-behavior
実装の動作を定義します。例えば、スタンドアロンのテキストや画像を、コンポーネントを模倣して移動または削除可能にすることもできます。

項目のタイプ item-types

data-aue-type
説明
data-aue-resource
data-aue-prop
data-aue-filter
data-aue-label
data-aue-model
data-aue-behavior
text
テキストは HTML タグ内で編集できますが、単純なテキスト形式でのみ編集でき、リッチテキスト書式は使用できません。これは、タイトルコンポーネントなどで一般的に使用されます。
オプション
必須
n/a
オプション
n/a
オプション
richtext
テキストは、完全なリッチテキスト機能で編集できます。RTE が右側のパネルに表示されます。
オプション
必須
n/a
オプション
n/a
オプション
media
画像やビデオなどのアセットは編集可能です
オプション
必須
オプション
アセットセレクターに渡される画像またはビデオのフィルター条件のリスト
オプション
n/a
オプション
container
編集可能は、別名「段落システム」と呼ばれるコンポーネントのコンテナとして動作します。
状況によって異なる
は以下を参照
状況によって異なる
以下を参照
オプション
許可されたコンポーネントのリスト
オプション
n/a
n/a
component
編集可能はコンポーネントです。さらなる機能は追加しません。DOM の移動可能/削除可能な部分を示し、プロパティパネルとそのフィールドを開くために必要になります。
必須
n/a
n/a
オプション
オプション
n/a
reference
参照は編集可能で、例えば、コンテンツフラグメント、エクスペリエンスフラグメントまたは製品があります。
状況によって異なる
は以下を参照
状況によって異なる
以下を参照
オプション
参照セレクターに渡されるコンテンツフラグメント、製品またはエクスペリエンスフラグメントのフィルター条件のリスト
オプション
オプション
n/a

ユースケースに応じて、data-aue-prop または data-aue-resource は必要な場合と不要な場合があります。次に例を示します。

  • data-aue-resource は、GraphQL 経由でコンテンツフラグメントに対してクエリを実行し、リストをコンテキスト内で編集可能にする場合は必須です。
  • data-aue-prop は、参照されるコンテンツフラグメントのコンテンツをレンダリングするコンポーネントがあり、コンポーネント内の参照を更新する場合は必須です。

動作 behaviors

data-aue-behavior
説明
component
スタンドアロンのテキスト、リッチテキストおよびメディアにコンポーネントを模倣させて、ページ上で移動や削除できるようにするために使用します
container
コンテナを独自のコンポーネントとして扱い、ページ上で移動や削除できるようにするために使用します

その他のリソース additional-resources

ユニバーサルエディターの詳細については、次のドキュメントを参照してください。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab