Lightning コンポーネント開発者ガイド
jLightning コンポーネントバンドルのデザインリソース
デザインリソースを使用して、Lightning アプリケーションビルダーなどのビルダーツールに公開する属性を制御します。デザインリソースは .cmp リソースと同じフォルダに存在します。このリソースには、Lightning コンポーネントの設計時の動作 (ページまたはアプリケーションでコンポーネントを表示するためにビジュアルツールが必要とする情報) が記述されます。
たとえば、「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>design:component
これは、デザインリソースのルート要素です。これには、使用するツール (アプリケーションビルダーなど) に関する、コンポーネントの設計時の設定が含まれます。
| 属性 | 説明 |
|---|---|
| label | Lightning アプリケーションビルダーに表示するときのコンポーネントの表示ラベルを設定します。カスタム Lightning ページテンプレートコンポーネントを作成するときに、このテキストが Lightning アプリケーションビルダーの新規ページウィザードにテンプレートの名前として表示されます。 |
design:attribute
Lightning コンポーネントの属性をシステム管理者が Lightning アプリケーションビルダーで編集できるようにするには、属性の design:attribute ノードをデザインリソースに追加します。コンポーネント定義で必須とマークされた属性は、デフォルト値が割り当てられている場合を除き、Lightning アプリケーションビルダーで自動的にユーザに表示されます。
デザインリソースでは、Integer、String、または Boolean 型の属性のみがサポートされます。
| 属性 | 説明 |
|---|---|
| datasource | 静的値を含む選択リストとして項目を表示します。文字列属性でのみサポートされます。Apex クラスを使用して選択リスト値を動的に設定することもできます。詳細は、「カスタムコンポーネントの動的選択リストの作成」を参照してください。 デザインリソースに datasource が設定された文字列属性はすべて選択リストとして処理されます。 |
| default | デザインリソース内の属性のデフォルト値を設定します。 |
| description | プロパティペ���ンに属性の i バブルとして表示されます。 |
| label | プロパティペインに表示する属性の表示ラベル。 |
| max | 属性が Integer の場合、属性の最大許容値が設定されます。属性が String の場合、これは属性の最大許容長です。 |
| min | 属性が Integer の場合、属性の最小許容値が設定されます。属性が String の場合、これは属性の最小許容長です。 |
| name | 必須属性。この値は .cmp リソースの aura:attribute 名の値と一致する必要があります。 |
| placeholder | プロパティペインに表示するときの属性の入力プレースホルダテキスト。 |
| required | 属性が必須かどうかを示します。省略した場合、デフォルトの false になります。 |
<sfdc:object> および <sfdc:objects>
これらのタグセットを使用して、コンポーネントを 1 つ以上のオブジェクトに制限します。
次に、2 つのオブジェクトに制限された同じ「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 <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 です。