Lightning アプリケーションビルダーの動的インタラクション用のコンポーネント設定

動的インタラクションを機能させるためには、管理者と開発者の両方が関与する必要がありますが、最も重要になるのは、トリガとなるイベントのプロパティを定義するカスタムソースコンポーネントです。イベントのメタデータとプロパティをソースコンポーネントに追加して、イベントを Lightning アプリケーションビルダーに公開します。これにより、管理者がイベントの対象とインタラクションを設定できます。

ソースコンポーネントにできるのは Lightning Web コンポーネントのみですが、すべてのコンポーネント (Aura または LWC) を対象にできます。ソースコンポーネントからイベントを公開するには、その .js ファイルで標準 JavaScript CustomEvent を起動します。イベントを検出できるようにするには、ビルダーのプロパティを公開する方法と同様に、コンポーネントの js-meta.xml ファイルで、動的インタラクション専用のメタデータを使用します。

動的インタラクションの概要については、「Salesforce ヘルプ」を参照してください。

Note

動的インタラクションでは、ソースコンポーネントのバンドルの componentName.js-meta.xml ファイルに記述できる 2 つの targetConfig サブタグを使用してイベントを公開します。

  • event
  • schema

これらのサブタグは、対象が lightning__AppPagetargetConfig でのみ使用できます。

Note

取引先リストソースコンポーネントのサンプル js-meta.xml 設定ファイルを次に示します。これには itemselected イベントが含まれ、そのスキーマには .js ファイルで定義される apiName および recordId が含まれます。

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
  <apiVersion>52.0</apiVersion>
  <isExposed>true</isExposed>
  <masterLabel>Account List</masterLabel>
  <targets>
    <target>lightning__AppPage</target>
  </targets>
  <targetConfigs>
    <targetConfig targets="lightning__AppPage">
      <property name="apiName" type="String"/>
      <property name="listViewApiName" type="String"/>
      <event name="itemselected" label="Item Selected" description="This event fires when an item is selected.">
        <schema>
          {
            "type": "object",
            "properties": {
              "recordId": {
                "type": "string",
                "title": "Record ID"
                "description": "Enter an 18-digit record ID."
          },
              "apiName": {
                "type": "string"
              }
            }
          }
        </schema>
      </event>
    </targetConfig>
  </targetConfigs>
  <description>meta xml description</description>
</LightningComponentBundle>

.js-meta.xml ファイルに関する考慮事項 

  • 動的インタラクションでは、スキーマの typeproperties のみが使用されます。スキーマの他の項目はすべて無視されます。
  • サポートされているプロパティ属性は、typetitle、および description のみです。
  • イベントスキーマでサポートされている有効なプロパティ種別は String、Integer、Boolean のみです。
  • event タグのメタデータは、.js ファイルに対して検証されません。

関連トピック

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。