モデル定義、フィールドおよびコンポーネントタイプ field-types

ユニバーサルエディターがプロパティパネルで編集できるフィールドとコンポーネントタイプの例について説明します。モデル定義を作成し、コンポーネントにリンクすることで、独自のアプリを実装する方法を理解します。

概要 overview

ユニバーサルエディターで使用する独自のアプリを適応させる場合は、コンポーネントを実装し、エディターのプロパティパネルで操作できるフィールドとコンポーネントタイプを定義する必要があります。これを行うには、モデルを作成し、コンポーネントからそのモデルにリンクします。

このドキュメントでは、モデル定義の概要、フィールドの概要および使用可能なコンポーネントタイプと設定例を説明します。

TIP
ユニバーサルエディター用のアプリの実装方法がわからない場合は、AEM 開発者向けのユニバーサルエディターの概要ドキュメントを参照してください。

モデル定義構造 model-structure

ユニバーサルエディターのプロパティパネルを使用してコンポーネントを設定するには、モデル定義が存在し、そのコンポーネントにリンクされている必要があります。

モデル定義は、モデルの配列から始まる JSON 構造です。

[
  {
    "id": "model-id",        // must be unique
    "fields": []             // array of fields which shall be rendered in the properties rail
  }
]

fields 配列を定義する方法について詳しくは、このドキュメントの​ フィールド ​の節を参照してください。

コンポーネントでモデル定義を使用するには、data-aue-model 属性を使用できます。

<div data-aue-resource="urn:datasource:/content/path" data-aue-type="component"  data-aue-model="model-id">Click me</div>

モデル定義の読み込み loading-model

モデルを作成した後は、外部ファイルとして参照できます。

<script type="application/vnd.adobe.aue.model+json" src="<url-of-model-definition>"></script>

または、モデルをインラインで定義することもできます。

<script type="application/vnd.adobe.aue.model+json">
  { ... model definition ... }
</script>

フィールド fields

フィールドオブジェクトには次のタイプ定義があります。

設定
値タイプ
説明
必須
component
ComponentType
コンポーネントのレンダラー
はい
name
string
データを保持するプロパティ
はい
label
FieldLabel
フィールドのラベル
はい
description
FieldDescription
フィールドの説明
いいえ
placeholder
string
フィールドのプレースホルダー
いいえ
value
FieldValue
デフォルト値
いいえ
valueType
ValueType
標準の検証は次が可能です。stringstring[]numberdateboolean
いいえ
required
boolean
必須フィールドです
いいえ
readOnly
boolean
フィールド読み取り専用です
いいえ
hidden
boolean
デフォルトで非表示になっているフィールドです
いいえ
condition
RulesLogic
条件に基づいてフィールドの表示/非表示を切り替えるルール
いいえ
multi
boolean
フィールドが複数フィールドです
いいえ
validation
ValidationType
フィールドの検証ルール
いいえ
raw
unknown
コンポーネントで使用できる生データ
いいえ

コンポーネントタイプ component-types

次に、フィールドのレンダリングに使用できるコンポーネントタイプを示します。

説明
コンポーネントのタイプ
AEM タグ
aem-tag
AEM コンテンツ
aem-content
ブーリアン
boolean
チェックボックスグループ
checkbox-group
コンテナ
container
日時
date-time
複数選択
multiselect
数値
number
ラジオグループ
radio-group
参照
reference
リッチテキスト
rich-text
選択
select
タブ
tab
テキスト
text

AEM タグ aem-tag

AEM タグコンポーネントタイプでは、AEM タグピッカーを使用して、コンポーネントにタグを付けることができます。

サンプル
code language-json
{
  "id": "aem-tag-picker",
  "fields": [
    {
      "component": "aem-tag",
      "label": "AEM Tag Picker",
      "name": "cq:tags",
      "valueType": "string"
    }
  ]
}
スクリーンショット
AEM タグコンポーネントタイプのスクリーンショット

AEM コンテンツ aem-content

AEM コンテンツコンポーネントタイプでは、AEM コンテンツピッカーを使用して、コンテンツ参照を設定できます。

サンプル
code language-json
{
  "id": "aem-content-picker",
  "fields": [
    {
      "component": "aem-content",
      "name": "reference",
      "value": "",
      "label": "AEM Content Picker",
      "valueType": "string"
    }
  ]
}
スクリーンショット
AEM コンテンツコンポーネントタイプのスクリーンショット

ブーリアン boolean

ブーリアンのコンポーネントタイプは、切り替えスイッチとしてレンダリングされた単純な true/false 値を格納します。追加の検証タイプを提供します。

検証タイプ
値タイプ
説明
必須
customErrorMsg
string
入力された値がブーリアン値でない場合に表示されるメッセージ
いいえ
サンプル 1
code language-json
{
  "id": "boolean",
  "fields": [
    {
      "component": "boolean",
      "label": "Boolean",
      "name": "boolean",
      "valueType": "boolean"
    }
  ]
}
サンプル 2
code language-json
{
  "id": "another-boolean",
  "fields": [
    {
      "component": "boolean",
      "label": "Boolean",
      "name": "boolean",
      "valueType": "boolean",
      "validation": {
        "customErrorMsg": "Think, McFly. Think!"
      }
    }
  ]
}
スクリーンショット
ブーリアンコンポーネントタイプのスクリーンショット

チェックボックスグループ checkbox-group

ブール値と同様に、チェックボックスグループコンポーネントタイプでは、複数の true / false 項目を選択でき、複数のチェックボックスとしてレンダリングできます。

サンプル
code language-json
{
  "id": "checkbox-group",
  "fields": [
    {
      "component": "checkbox-group",
      "label": "Checkbox Group",
      "name": "checkbox",
      "valueType": "string[]",
      "options": [
        { "name": "Option 1", "value": "option1" },
        { "name": "Option 2", "value": "option2" }
      ]
    }
  ]
}
スクリーンショット
チェックボックスグループコンポーネントタイプのスクリーンショット

コンテナ container

コンテナコンポーネントタイプを使用すると、コンポーネントをグループ化できます。追加の設定を提供します。

設定
値タイプ
説明
必須
collapsible
boolean
コンテナが折りたたみ可能かどうか
いいえ
サンプル 1
code language-json
[
  {
    "id": "aem-content-fragment",
    "fields": [
      {
        "component": "aem-content-fragment",
        "name": "picker",
        "label": "Content Fragment Picker",
        "valueType": "string",
        "variationName": "contentFragmentVariation"
      }
    ]
  }
]
スクリーンショット
コンテンツフラグメントピッカーのスクリーンショット

日時 date-time

日時コンポーネントタイプを使用すると、日付、時刻、またはその組み合わせを指定できます。 追加の設定を提供します。

設定
値タイプ
説明
必須
displayFormat
string
日付文字列を表示するフォーマット
はい
valueFormat
string
日付文字列を格納する形式
はい

また、追加の検証タイプも提供します。

検証タイプ
値タイプ
説明
必須
customErrorMsg
string
valueFormat が満たされない場合に表示するメッセージ
いいえ
サンプル 1
code language-json
{
  "id": "date-time",
  "fields": [
    {
      "component": "date-time",
      "label": "Date & Time",
      "name": "date",
      "valueType": "date"
    }
  ]
}
サンプル 2
code language-json
{
  "id": "another-date-time",
  "fields": [
    {
      "component": "date-time",
       "valueType": "date-time",
      "name": "field1",
      "label": "Date Time",
      "description": "This is a date time field that stores both date and time.",
      "required": true,
      "placeholder": "YYYY-MM-DD HH:mm:ss",
      "displayFormat": null,
      "valueFormat": null,
      "validation": {
        "customErrorMsg": "Marty! You have to come back with me!"
      }
    },
    {
      "component": "date-time",
      "valueType": "date",
      "name": "field2",
      "label": "Another Date Time",
      "description": "This is another date time field that only stores the date.",
      "required": true,
      "placeholder": "YYYY-MM-DD",
      "displayFormat": null,
      "valueFormat": null,
      "validation": {
        "customErrorMsg": "Back to the future!"
      }
    },
    {
      "component": "date-time",
      "valueType": "time",
      "name": "field3",
      "label": "Yet Another Date Time",
      "description": "This is another date time field that only stores the time.",
      "required": true,
      "placeholder": "HH:mm:ss",
      "displayFormat": null,
      "valueFormat": null,
      "validation": {
        "customErrorMsg": "Great Scott!"
      }
    }
  ]
}
スクリーンショット
日時コンポーネントタイプのスクリーンショット

エクスペリエンスフラグメント experience-fragment

エクスペリエンスフラグメントピッカーを使用すると、エクスペリエンスフラグメントと(必要に応じて)そのバリエーションを選択できます。追加の設定を提供します。

設定
値タイプ
説明
必須
variationName
string
選択したバリエーションを保存する変数名。未定義の場合、バリエーションピッカーは表示されません
いいえ
サンプル 1
code language-json
[
  {
    "id": "aem-experience-fragment",
    "fields": [
      {
        "component": "aem-experience-fragment",
        "name": "picker",
        "label": "Experience Fragment Picker",
        "valueType": "string",
        "variationName": "experienceFragmentVariation"
      }
    ]
  }
]
スクリーンショット
エクスペリエンスフラグメントピッカーのスクリーンショット

複数選択 multiselect

複数選択コンポーネントタイプでは、選択可能な要素をグループ化する機能など、ドロップダウンで選択する複数の項目が表示されます。

サンプル 1
code language-json
{
  "id": "multiselect",
  "fields": [
    {
      "component": "multiselect",
      "name": "multiselect",
      "label": "Multi Select",
      "valueType": "string",
      "options": [
        { "name": "Option 1", "value": "option1" },
        { "name": "Option 2", "value": "option2" }
      ]
    }
  ]
}
サンプル 2
code language-json
{
  "id": "multiselect-grouped",
  "fields": [
    {
      "component": "multiselect",
      "name": "property",
      "label": "Multiselect field",
      "valueType": "string",
      "required": true,
      "maxSize": 2,
      "options": [
        {
          "name": "Theme",
          "children": [
            { "name": "Light", "value": "light" },
            { "name": "Dark",  "value": "dark" }
          ]
        },
        {
          "name": "Type",
          "children": [
            { "name": "Alpha", "value": "alpha" },
            { "name": "Beta", "value": "beta" },
            { "name": "Gamma", "value": "gamma" }
          ]
        }
      ]
    }
  ]
}
スクリーンショット
複数選択コンポーネントタイプのスクリーンショット
グループ化を含む複数選択コンポーネントタイプのスクリーンショット

数値 number

数値コンポーネントタイプを使用すると、数値を入力できます。 追加の検証タイプを提供します。

検証タイプ
値タイプ
説明
必須
numberMin
number
許可される最小数
いいえ
numberMax
number
許可される最大数
いいえ
customErrorMsg
string
numberMin または numberMax が満たされない場合に表示するメッセージ。
いいえ
サンプル 1
code language-json
{
  "id": "number",
  "fields": [
    {
      "component": "number",
      "name": "number",
      "label": "Number",
      "valueType": "number",
      "value": 0
    }
  ]
}
サンプル 2
code language-json
{
  "id": "another-number",
  "fields": [
   {
      "component": "number",
      "valueType": "number",
      "name": "field1",
      "label": "Number Field",
      "description": "This is a number field.",
      "required": true,
      "placeholder": null,
      "validation": {
        "numberMin": 0,
        "numberMax": 88,
        "customErrorMsg": "You also need 1.21 gigawatts."
      }
    }
  ]
}
スクリーンショット
数値コンポーネントタイプのスクリーンショット

ラジオグループ radio-group

ラジオグループコンポーネントタイプを使用すると、チェックボックスグループと同様のグループとしてレンダリングされる複数のオプションから、相互に排他的な選択を行うことができます。

サンプル
code language-json
{
  "id": "radio-group",
  "fields": [
    {
      "component": "radio-group",
      "label": "Radio Group",
      "name": "radio",
      "valueType": "string",
      "options": [
        { "name": "Option 1", "value": "option1" },
        { "name": "Option 2", "value": "option2" }
      ]
    }
  ]
}
スクリーンショット
ラジオグループコンポーネントタイプのスクリーンショット

参照 reference

参照コンポーネントタイプを使用すると、現在のオブジェクトから別のデータオブジェクトへの参照が可能になります。

サンプル
code language-json
{
  "id": "reference",
  "fields": [
    {
      "component": "reference",
      "label": "Reference",
      "name": "reference",
      "valueType": "string"
    }
  ]
}
スクリーンショット
参照コンポーネントタイプのスクリーンショット

リッチテキスト rich-text

リッチテキストを使用すると、複数行のリッチテキスト入力が可能になります。追加の検証タイプを提供します。

検証タイプ
値タイプ
説明
必須
maxSize
number
許可される最大文字数
いいえ
customErrorMsg
string
maxSize を超過している場合に表示するメッセージ
いいえ
サンプル 1
code language-json
{
  "id": "richtext",
  "fields": [
    {
      "component": "richtext",
      "name": "rte",
      "label": "Rich Text",
      "valueType": "string"
    }
  ]
}
サンプル 2
code language-json
{
  "id": "another-richtext",
  "fields": [
    {
      "component": "richtext",
      "name": "rte",
      "label": "Rich Text",
      "valueType": "string",
      "validation": {
        "maxSize": 1000,
        "customErrorMsg": "That's about as funny as a screen door on a battleship."
      }
    }
  ]
}
スクリーンショット
テキストエリアコンポーネントタイプのスクリーンショット

選択 select

選択コンポーネントタイプでは、ドロップダウンメニューの定義済みオプションのリストから 1 つのオプションを選択できます。

サンプル
code language-json
{
  "id": "select",
  "fields": [
    {
      "component": "select",
      "label": "Select",
      "name": "select",
      "valueType": "string",
      "options": [
        { "name": "Option 1", "value": "option1" },
        { "name": "Option 2", "value": "option2" }
      ]
    }
  ]
}
スクリーンショット
選択コンポーネントタイプのスクリーンショット

タブ tab

タブコンポーネントタイプを使用すると、他の入力フィールドを複数のタブでグループ化して、作成者向けにレイアウト構成を改善することができます。

tab 定義は、fields の配列の区切り記号として見なすことができます。 tab より後のものはすべて、新しい tab が検出されるまでそのタブに配置され、それ以降は次の項目が新しいタブに配置されます。

すべてのタブに項目を表示する場合は、その項目をタブの前に定義する必要があります。

サンプル
code language-json
{
  "id": "tab",
  "fields": [
    {
      "component": "tab",
      "label": "Tab 1",
      "name": "tab1"
    },
    {
      "component": "text-input",
      "label": "Text 1",
      "name": "text1",
      "valueType": "string"
    },
    {
      "component": "tab",
      "label": "Tab 2",
      "name": "tab2"
    },
    {
      "component": "text-input",
      "label": "Text 2",
      "name": "text2",
      "valueType": "string"
    }
  ]
}
スクリーンショット
タブコンポーネントタイプのスクリーンショット

テキスト text

テキストを使用すると、1 行のテキスト入力が可能になります。追加の検証タイプも含まれます。

検証タイプ
値タイプ
説明
必須
minLength
number
許可される最小文字数
いいえ
maxLength
number
許可される最大文字数
いいえ
regExp
string
入力テキストが一致する必要がある正規表現
いいえ
customErrorMsg
string
minLengthmaxLength、または regExp が違反の場合に表示されるメッセージ
いいえ
サンプル 1
code language-json
{
  "id": "simpletext",
  "fields": [
    {
      "component": "text",
      "name": "text",
      "label": "Simple Text",
      "valueType": "string"
    }
  ]
}
サンプル 2
code language-json
{
  "id": "another simpletext",
  "fields": [
    {
      "component": "text",
      "name": "text",
      "label": "Simple Text",
      "valueType": "string",
      "description": "This is a text input with validation.",
      "required": true,
      "validation": {
        "minLength": 1955,
        "maxLength": 1985,
        "regExp": "^foo:.*",
        "customErrorMsg": "Why don't you make like a tree and get outta here?"
      }
    }
  ]
}
スクリーンショット
テキストコンポーネントタイプのスクリーンショット
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab