属性とタイプ

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

はじめに

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

メモ

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

データプロパティ

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

項目のタイプ

itemtype 説明 itemid itemprop data-editor-itemfilter data-editor-itemlabel data-editor-itemmodel data-editor-behvior
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

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

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

動作

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

その他のリソース

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

このページ