Lightning Aura Components Developer Guide (Lightning Aura コンポーネント開発者ガイド)
jAura コンポーネントバンドルのデザインリソース
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 アプリケーションビルダーの新規ページウィザードにテンプレートの名前として表示されます。 |
design:attribute
Aura コンポーネントの属性をシステム管理者がアプリケーションビルダーなどのツールで編集できるようにするには、属性の design:attribute ノードをデザインリソースに追加します。コンポーネント定義で必須とマークされた属性は、デフォルト値が割り当てられている場合を除き、自動的に表示されます。
Lightning ページのインターフェースの場合、デザインリソースでは、Integer、String、または Boolean 型の属性のみがサポートされます。lightning:availableForFlowScreens インターフェースでサポートされる属性型については、「フローでサポートされている Aura 属性型」を参照してください。
| 属性 | 説明 |
|---|---|
| datasource | 静的値を含む選択リストとして項目を表示します。文字列属性でのみサポートされます。Apex クラスを使用して選択リスト値を動的に設定することもできます。詳細は、「カスタムコンポーネントの動的選択リストの作成」を参照してください。 デザインリソースに datasource が設定された文字列属性はすべて選択リストとして処理されます。 |
| default | デザインリソース内の属性のデフォルト値を設定します。 |
| description | ツールに属性の i バブルとして表示されます。 |
| label | ツールに表示する属性の表示ラベル。 |
| max | 属性が Integer の場合、属性の最大許容値が設定されます。属性が String の場合、これは属性の最大許容長です。 |
| min | 属性が Integer の場合、属性の最小許容値が設定されます。属性が String の場合、これは属性の最小許容長です。 |
| name | 必須属性。この値は .cmp リソースの aura:attribute 名の値と一致する必要があります。 |
| placeholder | ツールに表示するときの属性の入力プレースホルダテキスト。 |
| required | 属性が必須かどうかを示します。省略した場合、デフォルトの false になります。 |
<design:suppportedFormFactors> と <design:suppportedFormFactor>
これらのタグセットは、コンポーネントがサポートするデバイスを指定するために使用します。design:suppportedFormFactor サブタグは type 属性をサポートします。有効な type 値は、Large (デスクトップ) と Small (電話) です。
コンポーネントがサポートするフォームファクタを宣言しないと、デフォルトでは、割り当てられているページ種別と同じフォームファクタをサポートします。アプリケーションページは、[Large (デスクトップ)] と [Small (電話)] のフォームファクタをサポートします。レコードページとホームページは、[Large (デスクトップ)] のフォームファクタのみをサポートします。
アプリケーションページは電話とデスクトップの両方をサポートするため、このページ上のコンポーネントは電話でもデスクトップでも表示できます。レコードページとホームページはデスクトップのみをサポートするため、これらのページ上のコンポーネントはデスクトップのみで表示できます。
たとえば、デスクトップと電話の両方をサポートするアプリケーションページでは、design:suppportedFormFactor を使用して、そのページを特定のデバイスで閲覧した場合にのみ表示されるようにコンポーネントを設定できます。たとえば、アプリケーションページのコンポーネントが [Small (電話)] のみをサポートするように制限した場合、そのページをデスクトップで表示すると、そのコンポーネントは表示されません。そのページを電話端末で表示すると、そのコンポーネントが表示されます。
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:supportedFormFactors>
5 <design:supportedFormFactor type="Large"/>
6 <design:supportedFormFactor type="Small"/>
7 </design:supportedFormFactors>
8</design:component><sfdc:objects> と <sfdc:object>
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:supportedFormFactors>
5 <design:supportedFormFactor type="Large"/>
6 <design:supportedFormFactor type="Small"/>
7 </design:supportedFormFactors>
8 <sfdc:objects>
9 <sfdc:object>Custom__c</sfdc:object>
10 <sfdc:object>Opportunity</sfdc:object>
11 </sfdc:objects>
12</design:component>オブジェクトをパッケージからインストールする場合、<sfdc:object> タグセットにオブジェクトを含めるときにオブジェクト名の先頭に namespace__ の文字列を追加します。たとえば、objectNamespace__ObjectApiName__c です。
サポートされるオブジェクトの詳細は、『ユーザインターフェース API 開発者ガイド』を参照してください。