クイックアクション用のコンポーネントの設定
クイックアクションとして Lightning Web コンポーネントを使用するには、コンポーネントのメタデータを定義します。
LWC のクイックアクションには_画面クイックアクション_と_ヘッドレスクイックアクション_の 2 種類があります。
- 画面クイックアクションではモーダルウィンドウのコンポーネントが表示されます。「画面クイックアクションの作成」を参照してください。
- ヘッドレスクイックアクションでは、
@api invoke()
メソッドで指定したカスタムコードが実行されます。「ヘッドレスクイックアクションの作成」を参照してください。
Lightning Web コンポーネントは、レコードページでのみクイックアクションとして使用できます。Lightning Web コンポーネントをグローバルクイックアクションとして使用することはできません。
コンポーネントのプロジェクトフォルダには、コンポーネントのメタデータ値を定義する設定ファイル (componentName.js-meta.xml
ファイル) を含める必要があります。コンポーネントをクイックアクションとして使用するには、次の手順を実行してファイルを設定します。
targets
で、lightning__RecordAction
をtarget
として追加し、Lightning Web コンポーネントをレコードページのクイックアクションとして指定します。targetConfig
を追加し、targets
をlightning__RecordAction
に設定します。actionType
をScreenAction
またはAction
に設定して、クイックアクション種別を選択します。actionType
を指定しない場合は、クイックアクションのデフォルトは画面アクションになります。
次の設定ファイルでは、画面アクションを定義します。
次の設定ファイルでは、ヘッドレスアクションを定義します。
「XML 設定ファイルの要素」の完全なリストを参照してください。
Salesforce の [設定] で、[オブジェクトマネージャ] ページを介してオブジェクト固有のアクションを作成します。次に、アクションをページレイアウトの [Salesforce モバイルおよび Lightning Experience のアクション] セクションに追加します。Salesforce ヘルプの「クイックアクション」を参照してください。
Lightning Web コンポーネントのクイックアクションとしての使用は、Salesforce モバイルアプリケーションではサポートされていません。
関連トピック