LightningComponentBundle
特別なアクセスルール
LightningComponentBundle コンポーネントは、名前空間が定義されている組織でのみ作成できます。
Summer '20 以降、この型にアクセスできるのは、Salesforce 組織の内部ユーザのみとなります。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| apiVersion | double | コンポーネントを Salesforce API バージョンにバインドする double 値。 |
| capabilities | Capabilities[] | 機能のリスト。機能とは、コンポーネントが実行できることで、対象と対照をなします。対象は、コンポーネントを使用できる場所です。API バージョン 48.0 以降で利用できます。 |
| description | string | Lightning Web コンポーネントの説明。 |
| isExplicitImport | boolean | ファイル間のインポートが開発者によって明示的に行われるか (true)、フレームワークによって暗黙的に行われるか (false) を示します。 |
| isExposed | boolean | 管理パッケージでコンポーネントを使用できるか (true)、否か (false) を示します。 |
| lwcResources | LwcResources[] | バンドル内のリソースのリスト。 |
| masterLabel | string | リストビューに表示されるコンポーネントタイトル。 |
| targetConfigs | base64Binary | 各対象の設定。各対象は Lightning ページ種別です。たとえば、この設定により、Lightning Web コンポーネントを Lightning アプリケーションビルダーの取引先責任者レコードページで使用できます。 |
| targets | Targets[] | Lightning Web コンポーネントがサポートされる対象のリスト。各対象は、Lightning アプリケーションビルダーで設定可能な Lightning ページ種別です。 |
機能
機能のリストを表します。機能とは、コンポーネントが実行できることで、対象と対照をなします。対象は、コンポーネントを使用できる場所です。API バージョン 48.0 以降で利用できます。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| capability | string | コンポーネントによって実行できる何らかの機能を指定します。有効な値は、lightningCommunity__RelaxedCSP のみです。この値を設定すると、管理パッケージからインストールされたコンポーネントを Lightning Locker が無効になっている Experience Cloud サイトで実行できるようになります。 |
LwcResources
LightningComponentBundle 内のリソースのリストを表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| lwcResource | LwcResource | LightningComponentBundle 内のリソース。 |
LwcResource
LightningComponentBundle 内のリソースを表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| filePath | string | 必須。リソースのファイルパス。 |
| source | base64Binary | 必須。リソースの内容。 |
Targets
Lightning Web コンポーネントでサポートされるコンテナのリストを表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| target | string | Lightning アプリケーションビルダーでコンポーネントを追加可能な Lightning ページの種別を指定します。 有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
この package.xml ファイルは、組織のすべての LightningComponentBundle コンポーネントを取得します。
取得した zip ファイルで、各 Lightning Web コンポーネントは lwc フォルダ内にネストされます。
次の例は、名前が hello の 1 つのコンポーネントの zip ファイル内のディレクトリ構造を示しています。
hello ディレクトリ内のファイルの内容は次のとおりです。
hello.html の内容:
hello.js の内容:
hello.js-meta.xml の内容。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照���てください。