AuraDefinitionBundle

ファイルのサフィックスおよびディレクトリの場所

AuraDefinitionBundle コンポーネントは、定義ファイルが含まれるフォルダです。他のほとんどのメタデータコンポーネントとは異なり、AuraDefinitionBundle コンポーネントは 1 つのファイルではなく、ファイルのコレクションです。各ファイルは、マークアップ、アプリケーション、コードファイル (コントローラとヘルパーを含む)、イベント、ドキュメント、インターフェースなど、バンドル内のリソースを表します。たとえば、次のディレクトリ構造は、bundle1 と bundle2 という 2 つのバンドルのフォルダおよびファイルの階層を示します。

1aura
2    bundle1
3        bundle1.cmp
4        bundle1Controller.js
5    bundle2
6        bundle2.app
7        bundle2Controller.js
8        bundle2.auradoc

Aura 定義バンドルは、aura という名前の最上位フォルダの下に配置する必要があります。各バンドルには、aura フォルダの下に独自のサブフォルダが必要です。各定義ファイルの名前は、バンドル名で開始する必要があります。

バンドルにはサフィックスはありません。定義ファイルには、次のいずれかのサフィックスを使用できます。

各バンドルには、サフィックスがそれぞれ .app、.cmp、.design、.evt、.intf、または .tokens のファイルを 1 つのみ使用できます。

バージョン

AuraDefinitionBundle コンポーネントは、API バージョン 32.0 以降で使用できます。

設計コンポーネントと SVG コンポーネントは、API バージョン 33.0 以降で使用できます。

API バージョン 45.0 以降、2 種類の Lightning コンポーネント (Aura コンポーネントと Lightning Web コンポーネント) があります。このメタデータ型は、Aura コンポーネントについて説明します。

特別なアクセスルール

定義は、名前空間が定義されている組織でのみ作成できます。

項目

宣言的なメタデータの定義のサンプル

次の例では、AuraDefinitionBundle コンポーネントのディレクトリ構造を示します。

1aura
2    sampleCmp
3        sampleCmp.cmp
4        sampleCmpController.js

次のサンプルでは、サンプル aura ディレクトリに対応するメタデータ定義ファイルの内容を示します。

sampleCmp.cmp の内容:

1<aura:component>
2    <aura:attribute name="val1" type="String" default="Value"/>
3    <aura:attribute name="val2" type="String" />
4    <aura:handler name="init" value="{!this}" action="{!c.myAction}"/>
5        <ui:outputText value='Hello world!'/>
6        <ui:outputText value='{!v.val1}'/>
7        <ui:outputText value='{!v.val2}'/>
8</aura:component>

sampleCmpController.js の内容:

1({  
2  myAction : function(component) {
3    component.set('v.val1','Value1');
4    component.set('v.val2','Value2');
5  }
6})

次の package.xml は、sampleCmp バンドルに含まれるすべての Lightning コンポーネントの定義を参照します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>sampleCmp</members>
5        <name>AuraDefinitionBundle</name>
6    </types>
7    <version>56.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。