クイックアクション用のコンポーネントの設定

クイックアクションとして Lightning Web コンポーネントを使用するには、コンポーネントのメタデータを定義します。

画面クイックアクションとヘッドレスクイックアクション

LWC のクイックアクションには_画面クイックアクション_と_ヘッドレスクイックアクション_の 2 種類があります。

画面クイックアクションではモーダルウィンドウのコンポーネントが表示されます。「画面クイックアクションの作成」を参照してください。
ヘッドレスクイックアクションでは、@api invoke() メソッドで指定したカスタムコードが実行されます。「ヘッドレスクイックアクションの作成」を参照してください。

Lightning Web コンポーネントは、レコードページでのみクイックアクションとして使用できます。Lightning Web コンポーネントをグローバルクイックアクションとして使用することはできません。

Note

設定ファイルでコンポーネントのメタデータを定義する

コンポーネントのプロジェクトフォルダには、コンポーネントのメタデータ値を定義する設定ファイル (componentName.js-meta.xml ファイル) を含める必要があります。コンポーネントをクイックアクションとして使用するには、次の手順を実行してファイルを設定します。

targets で、lightning__RecordAction を target として追加し、Lightning Web コンポーネントをレコードページのクイックアクションとして指定します。
targetConfig を追加し、targets を lightning__RecordAction に設定します。
actionType を ScreenAction または Action に設定して、クイックアクション種別を選択します。actionType を指定しない場合は、クイックアクションのデフォルトは画面アクションになります。

次の設定ファイルでは、画面アクションを定義します。

1<?xml version="1.0" encoding="UTF-8" ?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3  <apiVersion>52.0</apiVersion>
4  <isExposed>true</isExposed>
5  <targets>
6    <target>lightning__RecordAction</target>
7  </targets>
8  <targetConfigs>
9    <targetConfig targets="lightning__RecordAction">
10      <actionType>ScreenAction</actionType>
11    </targetConfig>
12  </targetConfigs>
13</LightningComponentBundle>

次の設定ファイルでは、ヘッドレスアクションを定義します。

1<?xml version="1.0" encoding="UTF-8" ?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3  <apiVersion>52.0</apiVersion>
4  <isExposed>true</isExposed>
5  <targets>
6    <target>lightning__RecordAction</target>
7  </targets>
8  <targetConfigs>
9    <targetConfig targets="lightning__RecordAction">
10      <actionType>Action</actionType>
11    </targetConfig>
12  </targetConfigs>
13</LightningComponentBundle>

「XML 設定ファイルの要素」の完全なリストを参照してください。

Salesforce の [設定] でのクイックアクションの作成

Salesforce の [設定] で、[オブジェクトマネージャ] ページを介してオブジェクト固有のアクションを作成します。次に、アクションをページレイアウトの [Salesforce モバイルおよび Lightning Experience のアクション] セクションに追加します。Salesforce ヘルプの「クイックアクション」を参照してください。

Lightning Web コンポーネントのクイックアクションとしての使用は、Salesforce モバイルアプリケーションではサポートされていません。

Note

関連トピック

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。