Lightning コンポーネントバンドルのデザインリソース

Lightning コンポーネントの属性をシステム管理者が Lightning アプリケーションビルダーで編集できるようにするには、属性の design:attribute ノードをデザインリソースに追加します。コンポーネント定義で必須とマークされた属性は、デフォルト値が割り当てられている場合を除き、Lightning アプリケーションビルダーで自動的にユーザに表示されます。コンポーネント定義内のデフォルト値が設定された必須属性と必須とマークされていない属性は、デザインリソースで指定する必要があります。指定しないとユーザには表示されません。

デザインリソースでは、int、string、または boolean 型の属性のみがサポートされます。

デザインリソースで何ができますか?

項目を選択リストとして表示する

項目を静的値の選択リストとして表示するには、datasource をデザインリソースの属性に追加します。

1<design:attribute name="Name" datasource="value1,value2,value3" />

デザインリソースに datasource が設定された文字列属性はすべて選択リストとして処理されます。

属性のデフォルト値を設定する

デザインリソースでは、属性のデフォルト値を設定できます。

1<design:attribute name="Name" datasource="value1,value2,value3" default="value1" />

コンポーネントを 1 つ以上のオブジェクトに制限する

<sfdc:object> タグセットを使用して、コンポーネントをどのオブジェクトに対して有効にするかを指定します。

たとえば、「Hello World」コンポーネントと一緒にバンドルするデザインリソースを示します。

1<design:component label="Hello World">
2    <design:attribute name="subject" label="Subject" description="Name of the person you want to greet" />
3    <design:attribute name="greeting" label="Greeting" />
4</design:component>

2 つのオブジェクトに制限された同じデザインリソースを示します。

1<design:component label="Hello World">
2    <design:attribute name="subject" label="Subject" description="Name of the person you want to greet" />
3    <design:attribute name="greeting" label="Greeting" />
4    <sfdc:objects>
5        <sfdc:object>Custom__c</sfdc:object>
6        <sfdc:object>Opportunity</sfdc:object>
7    </sfdc:objects>
8</design:component>

オブジェクトをパッケージからインストールする場合、<sfdc:object> タグセットにオブジェクトを含めるときにオブジェクト名の先頭に namespace__ の文字列を追加します。たとえば、objectNamespace__ObjectApiName__c です。