属性とタイプ attributes-types

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

はじめに introduction

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

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

データプロパティ data-properties

データプロパティ
説明
data-aue-resource
リソースに対する URN。AEM のユニバーサルエディターを使用した概要ドキュメントページのインストルメントの節を参照してください。
data-aue-prop
リソースの属性。AEM のユニバーサルエディターを使用した概要ドキュメントページのインストルメントの節を参照してください。
data-aue-type
編集可能な項目のタイプ(テキスト、画像、参照など)
data-aue-filter
定義:
- 有効にする RTE 機能
- コンテナに追加できるコンポーネント
- メディアタイプに追加できるアセット
data-aue-label
エディターに表示される選択可能な項目のカスタムラベルを定義する
data-aue-model
プロパティパネルでフォームベースの編集に使用するモデルを定義する
data-aue-behavior
廃止。 かつては、スタンドアロンのテキスト、リッチテキスト、メディアをコンポーネントとして模倣できるようにインストルメンテーションの動作を定義していましたが、その後ページ上で移動および削除可能になり、component の単一の値を提供するようになりました。 このプロパティは無視され、data-aue-resource を持つ項目がコンテナの直接の子である場合、自動的にコンポーネントと見なされます。

項目のタイプ item-types

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

data-aue-resource はコンテンツの変更が書き込まれる場所を示すプライマリキーなので、常に必要です。

  • data-aue-type が設定されているタグに直接指定する必要はありません。
  • 設定されていない場合は、一番近い親の data-aue-resource 属性が使用されます。

コンテキスト内で編集を行う場合には、data-aue-prop は必須です。ただし、オプションであるコンテナを除きます(コンテナがコンテンツフラグメントで、prop が複数参照フィールドを指すように設定されている場合)。

  • data-aue-prop は、data-aue-resource のプライマリキーに対して更新する属性です。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab