XML 設定ファイルの要素
それぞれの Lightning Web コンポーネントフォルダには、componentName.js-meta.xml という名前の設定ファイルを含める必要があります。設定ファイルでは、Lightning アプリケーションビルダーとエクスペリエンスビルダーの対象やデザイン設定など、コンポーネントのメタデータ値を定義します。
Salesforce API バージョン 45.0 以上。apiVersion に関係なく、コンポーネントは常に最新バージョンの Lightning Data Service と Lightning 基本コンポーネントを使用します。Lightning Locker バージョンは、組織レベルで設定され、コンポーネントの apiVersion とは関係ありません。
機能とは、コンポーネントが実行できることを指します。これは、コンポーネントを使用できる場所を定義する対象と対照をなす用語です。
capability サブタグがサポートされます。
有効な値は、次のとおりです。
| 値 | 説明 |
|---|---|
lightningCommunity__RelaxedCSP | 管理パッケージからインストールされたコンポーネントを Lightning Locker が無効なエクスペリエンスビルダーサイトで実行できるようになります。この設定により、管理パッケージの開発者は、Lightning Locker が無効なサイトで Lightning Web コンポーネントを実行できます。lightningCommunity__RelaxedCSP タグを含まない管理パッケージ内の Lightning Web コンポーネントは、Lightning Locker が無効な任意のサイトにおいてエクスペリエンスビルダーの [コンポーネント] パネルで無効になります。 |
lightning__ServiceCloudVoiceToolkitApi | コンポーネントで Service Cloud Voice ツールキット API を使用できるようになります。lightning-service-cloud-voice-toolkit-api コンポーネントを使用するコンポーネントでは、lightning__ServiceCloudVoiceToolkitApi 機能を指定する必要があります。詳細は、lightning-service-cloud-voice-toolkit-api のドキュメントを参照してください。 |
lightning__dynamicComponent | あるコンポーネントから他のコンポーネントを動的にインスタンス化できるようにします。 |
コンポーネントの簡単な説明です。通常は 1 文です。[設定] の Lightning コンポーネントのリストのように、説明はリストビューで表示されます。Lightning アプリケーションビルダーとエクスペリエンスビルダーでは、ツールチップとして表示されます。
isExposed が false の場合、コンポーネントは、Lightning アプリケーションビルダーにもエクスペリエンスビルダーにも公開されません。
コンポーネントを Lightning アプリケーションビルダーまたはエクスペリエンスビルダーで使用できるようにするには、isExposed を true に設定し、Lightning ページの種別である <target> を 1 つ以上定義します。
カスタム Lightning Web コンポーネントは、カスタム名前空間の Lightning Web コンポーネントやモジュールにはアクセスできません。c および lightning 名前空間内の Lightning Web コンポーネントとモジュールにのみアクセスできます。
コンポーネントのタイトル。[設定] の Lightning コンポーネントのリストのように、リストビューで表示されます。Lightning アプリケーションビルダーとエクスペリエンスビルダーでも表示されます。
Vlocity Lightning Web コンポーネントの管理パッケージの名前空間。Salesforce ヘルプの「Vlocity ユーザインターフェースツール」を参照してください。
特定の種別の Lightning ページや組み込みサービスチャットなど、コンポーネントを追加できる場所を指定します。コンポーネントを Lightning アプリケーションビルダーまたはエクスペリエンスビルダーで表示する場合は、Lightning ページ種別を 1 つ以上指定します。
target サブタグがサポートされます。
ページ種別。有効な値は、次のとおりです。
| 値 | 説明 |
|---|---|
lightningCommunity__Default | このコンポーネントを選択すると、エクスペリエンスビルダーのコンポーネントで編集可能なプロパティを公開できるようになります。エクスペリエンスビルダーで編集できるのは lightningCommunity__Page または lightningCommunity__Theme_Layout の対象に定義されたプロパティのみです。 |
lightningCommunity__Page | ドラッグアンドドロップコンポーネントをエクスペリエンスビルダーのページで使用できるようにします。コンポーネントは [コンポーネント] パネルに表示されます。 |
lightningCommunity__Page_Layout | コンポーネントを LWR サイトのページレイアウトとしてエクスペリエンスビルダーで使用できるようにします。コンポーネントはコンテンツレイアウトウィンドウに表示されます。 |
lightningCommunity__Theme_Layout | コンポーネントを LWR サイトのテーマレイアウトとしてエクスペリエンスビルダーで使用できるようにします。コンポーネントは [テーマ] 領域の [設定] に表示されます。 |
lightningSnapin__ChatHeader | カスタムチャットヘッダーコンポーネントを組み込みサービスチャット設定から選択できるようにします。lightningsnapin/baseChatHeader モジュールをインポートするコンポーネントでは、その lightningSnapin__ChatHeader 対象を指定する必要があります。詳細は、lightningsnapin/baseChatHeader のドキュメントを参照してください。 |
lightningSnapin__ChatMessage | カスタムチャットメッセージコンポーネントを組み込みサービスチャット設定から選択できるようにします。lightningsnapin/baseChatMessage モジュールをインポートするコンポーネントでは、lightningSnapin__ChatMessage 対象を指定する必要があります。詳細は、lightningsnapin/baseChatMessage のドキュメントを参照してください。 |
lightningSnapin__Minimized | 最小化されたカスタムコンポーネントを組み込みサービスチャット設定から選択できるようにします。lightningsnapin/minimized モジュールをインポートするコンポーネントでは、lightningSnapin__Minimized 対象を指定する必要があります。詳細は、lightningsnapin/minimized のドキュメントを参照してください。 |
lightningSnapin__PreChat | カスタムの事前チャットコンポーネントを組み込みサービスチャット設定から選択できるようにします。lightningsnapin/basePrechat モジュールをインポートするコンポーネントでは、lightningSnapin__PreChat 対象を指定する必要があります。詳細は、lightningsnapin/basePrechat のドキュメントを参照してください。 |
lightningStatic__Email | コンポーネントをメールコンテンツビルダーで使用できるようにします。 |
lightning__AppPage | コンポーネントを Lightning アプリケーションビルダーのアプリケーションページで使用できるようにします。 |
lightning__FlowScreen | コンポーネントを Flow Builder のフロー画面で使用できるようにします。 |
lightning__HomePage | コンポーネントを Lightning アプリケーションビルダーのホームページで使用できるようにします。 |
lightning__Inbox | Outlook と Gmail の統合のためにメールアプリケーションペインに追加するコンポーネントを Lightning アプリケーションビルダーで使用できるようにします。 |
lightning__RecordAction | コンポーネントをレコードページのクイックアクションとして使用できるようにします。クイックアクションの種別を指定するには、actionType 属性を使用して targetConfig を定義します。 |
lightning__RecordPage | コンポーネントを Lightning アプリケーションビルダーのレコードページで使用できるようにします。 |
lightning__Tab | コンポーネントを Lightning Experience または Salesforce モバイルアプリケーションのカスタムタブで使用できるようにします。 |
lightning__UtilityBar | コンポーネントをアプリケーションマネージャのユーティリティバーのユーティリティ項目として使用できるようにします。 |
lightning_VoiceExtension | コンポーネントを Lightning アプリケーションビルダーの Voice 拡張機能ページで使用できるようにします。 |
analytics__Dashboard | コンポーネントを CRM Analytics ダッシュボードのウィジェットとして使用できるようにします。 |
さまざまなページ種別のコンポーネントを設定し、コンポーネントプロパティを定義します。たとえば、レコードホームページのコンポーネントは、Salesforce ホームページやアプリケーションページのコンポーネントとは異なるプロパティを持つことができます。エクスペリエンスビルダーサイトでコンポーネントプロパティをサポートしているのは、lightningCommunity__Default のみです。
targetConfig サブタグがサポートされます。
ページ種別の設定ごとに別々の targetConfig を使用します。targetConfig タグでサポートされる属性を次に示します。
| 属性 | 説明 | 必須 |
|---|---|---|
actionType | Lightning Web コンポーネントのクイックアクションの種別を指定します。サポートされている種別は ScreenAction と Action です。デフォルト値は、ScreenAction です。「クイックアクション用のコンポーネントの設定」を参照してください。target が lightning__RecordAction の場合のみサポートされます。 | いいえ |
configurationEditor | フロー画面コンポーネントのカスタムプロパティエディタを登録します。カスタムプロパティエディタは、カスタムフロー画面コンポーネントの入力属性を設定するためのカスタム UI を提供する Lightning Web コンポーネントです。「Flow Builder のアクションと画面コンポーネントの UI のカスタマイズ」を参照してください。target が lightning__FlowScreen の場合のみサポートされます。 | いいえ |
targets | targets 属性には、<targetConfig targets="lightning__RecordPage"> や <targetConfig targets="lightning__RecordPage,lightning__AppPage"> などのページ種別を 1 つ以上指定します。指定する targets 属性値は、コンポーネントの <targets> にリストしたページ種別の 1 つ以上に一致する必要があります。 | はい |
targetConfig タグでは、次のサブタグがサポートされています。
eventpropertypropertyTypeobjectsschemasupportedFormFactorshasStep
これらのサブタグでは、さまざまな属性やサブタグがサポートされています。
動的インタラクション用のイベントを公開することで、Lightning アプリケーションビルダーのコンポーネントプロパティパネルの [イベント] タブに表示されるようになります。
このタグは、target が lightning__AppPage の場合にのみ有効です。
event タグでサポートされる属性を次に示します。
| 属性 | 説明 | 必須 |
|---|---|---|
description | イベントの説明。Lightning アプリケーションビルダーのイベントラベルに i バブルとして表示されます。 | いいえ |
label | 管理しやすくするためのイベントの表示ラベル。 | いいえ |
name | .js ファイルで定義されるイベントの名前。label 属性が定義されていない場合、Lightning アプリケーションビルダーのコンポーネントの使用可能なイベントのリストに name の値が表示されます。 | はい |
Lightning アプリケーションビルダー、アプリケーションマネージャ、Flow Builder、またはエクスペリエンスビルダーで設定できるコンポーネントの公開プロパティを指定します。コンポーネント作成者は、@api デコレータを使用して、コンポーネントの JavaScript クラスのプロパティを定義します。
property タグでサポートされる属性を次に示します。
| 属性 | 説明 | 必須 |
|---|---|---|
datasource | 静的値を含む選択リストとして項目を表示します。サポートされるのは、type 属性が String の場合のみです。target が lightning__FlowScreen の場合はサポートされません。例: datasource="value1,value2,value3"。datasource="apex://MyCustomPickList" などの Apex クラスを使用して、選択リスト値を動的に設定することもできます。詳細は、「カスタムコンポーネントの動的選択リストの作成」を参照してください。 | いいえ |
default | 属性のデフォルト値 | いいえ |
description | ツールに属性の i 伝達として表示されます。 | いいえ |
exposedTo | screenResponsive 属性を使用する場合は必須です。有効な値は css です。 | いいえ |
filter | サポートされるのは、対象が lightningCommunity__Default で種別が ContentReference の場合のみです。エクスペリエンスビルダーのコンポーネントに表示する Salesforce CMS コンテンツタイプを指定します。有効な値は
| いいえ |
label | ツールに属性のラベルとして表示されます。 | いいえ |
max | 種別 Integer の属性の許容される最大値。target が lightning__FlowScreen の場合はサポートされません。 | いいえ |
min | 種別 Integer の属性の許容される最小値。target が lightning__FlowScreen の場合はサポートされません。 | いいえ |
name | コンポーネントのプロパティを設定する場合に必要です。属性名です。この値は、コンポーネントの JavaScript クラスのプロパティ名に一致する必要があります。 | はい |
placeholder | ツールに表示するときの属性の入力プレースホルダテキスト。このテキストは、ユーザが入力を開始する前のテキスト項目およびテキストエリアのゴーストテキストです。サポートされるのは、type 属性が String の場合のみです。target が lightning__FlowScreen の場合はサポートされません。 | いいえ |
required | 属性が必須かどうかを指定します。デフォルト値は、false です。 | いいえ |
role | 属性が inputOnly と outputOnly のいずれであるかを指定します。role 属性を指定しない場合は、デフォルト値により、入力と出力が許可されます。たとえば、プロパティが outputOnly に制限されている場合、ユーザは、Lightning レコードページからその値を設定できません。サポートされるのは、target が lightning__FlowScreen の場合のみです。role 属性を設定しないか、inputOnly に設定すると、プロパティがカスタムプロパティエディタに表示されます。outputOnly に設定すると、プロパティはカスタムプロパティエディタに表示されません。 | いいえ |
screenResponsive | コンポーネントの整数または文字列プロパティが画面サイズに対応するかどうかを指定します。デフォルト値は、false です。ユーザの画面サイズに応じてコンポーネントが正しいプロパティ値を使用できるようにするには、screenResponsive を true に設定し、exposedTo 属性を css に設定します。screenResponsive がサポートされるのは、対象が lightningCommunity__Default の場合のみです。 | いいえ |
type | 属性のデータ型。次の値は、すべての対象で有効です。この値が、コンポーネントの JavaScript モジュールのプロパティに割り当てられた型と一致していることを確認してください。型が一致しない場合、設定ファイルの値が優先されます。
lightningCommunity__Default の場合にのみ有効です。
lightningStatic__Email の場合にのみ有効です。
lightning__FlowScreen の場合にのみ有効です。
| はい |
フロー画面コンポーネントのコンポーネントプロパティ用に拡張するデータ型を定義します。拡張できるのは、汎用の sObject と sObject コレクションデータ型のみです。
サポートされるのは、対象が lightning__FlowScreen の場合のみです。
| 属性 | 説明 | 必須 |
|---|---|---|
extends | コンポーネントプロパティ用に拡張するデータ型を指定します。 | はい |
description | プロパティ種別の説明。 | いいえ |
label | プロパティ種別の表示ラベル。 | いいえ |
name | コンポーネントの property サブタグで定義されている各 type 属性から参照するデータ型名を指定します。「例: 画面コンポーネントの汎用 sObject 入力」を参照してください。 | はい |
コンポーネントを 1 つ以上のオブジェクトのセットに制限します。このタグセットを使用しない場合、コンポーネントではサポートされるオブジェクトがすべてサポートされます。このタグセットは、lightning__RecordPage 用に設定された親 targetConfig 内でのみ機能します。
objects タグセットは、targetConfig セット内で 1 回のみ指定します。
object サブタグがサポートされます。
コンポーネントがサポートされるオブジェクトを定義します。サポートされるオブジェクトごとに 1 つの object タグを使用します。
サポートされるオブジェクトの詳細は、『ユーザインターフェース API 開発者ガイド』を参照してください。
event の形状を指定します。schema タグのコンテンツは、JSON 形式である必要があります。
動的インタラクション機能では、スキーマの type と properties のみが使用されます。スキーマの他の項目はすべて無視されます。イベントスキーマでの有効なプロパティ種別は String、Integer、Boolean です。スキーマの例は、「Lightning アプリケーションビルダーの動的インタラクション用のコンポーネント設定」を参照してください。
サポートされるのは、target が lightning__AppPage の場合のみです。
コンポーネントでサポートされる 1 つ以上のフォーム要素またはデバイスのセット。supportedFormFactors タグセットは、targetConfig セット内で 1 回指定します。supportedFormFactor サブタグがサポートされます。
supportedFormFactors は、次の対象に対しては機能しません。
lightningCommunity__DefaultlightningCommunity__PagelightningCommunity__Page_LayoutlightningCommunity__Theme_Layout
コンポーネントでサポートされるフォーム要素またはデバイスを定義します。サポートされるフォーム要素ごとに 1 つの supportedFormFactor タグを使用します。
supportedFormFactor タグでサポートされる属性を次に示します。
| 属性 | 説明 | 必須 |
|---|---|---|
type | コンポーネントが表示されるデバイスフォーム要素。有効な値:
| はい |
サポートされるフォーム要素の情報をすべてのコンポーネントの設定ファイルに含めることを強くお勧めします。「異なるフォーム要素に合わせたコンポーネントの設定」を参照してください。
CRM Analytics クエリデータをダッシュボードのステップからコンポーネントに提供します。このタグは、analytics__Dashboard 対象でのみ機能します。hasStep タグはブーリアン型の設定で、デフォルト値は false です。
関連トピック
- コンポーネントの設定ファイル
- Lightning アプリケーションビルダーのコンポーネントの設定
- エクスペリエンスビルダーのコンポーネントの設定
- フロー画面のコンポーネントの設定
- ユーティリティバーのコンポーネントの設定
- 異なるフォーム要素に合わせたコンポーネントの設定
- Outlook および Gmail インテグレーションのコンポーネントの作成
- クイックアクション
- Salesforce ヘルプ: パッケージについて