フロー画面のコンポーネントの設定

カスタム Lightning Web コンポーネントをフロー画面で使用するには、コンポーネントの設定ファイルにいくつかのメタデータを追加します。

componentName.js-meta.xml ファイルは、フロー画面で使用することを目的としたコンポーネントのデザイン設定などのコンポーネントのメタデータ値を定義します。

コンポーネントをフロー画面で使用できるようにするには、lightning__FlowScreen 対象を追加します。
コンポーネントに入力項目を追加するには、targetConfig プロパティを追加します。
プロパティを inputOnly または outputOnly に制限するには、role 属性を使用します。たとえば、プロパティが outputOnly に制限されている場合、ユーザは、Lightning レコードページからその値を設定できません。role 属性を指定しない場合は、デフォルト値により、入力と出力が許可されます。

このサンプルコンポーネントには、5 つのフロー画面入力項目があります。startDate プロパティは inputOnly に設定されています。

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3  <apiVersion>47.0</apiVersion>
4  <isExposed>true</isExposed>
5  <masterLabel>Best Component Ever</masterLabel>
6  <description>This is a demo component.</description>
7  <targets>
8    <target>lightning__FlowScreen</target>
9  </targets>
10  <targetConfigs>
11    <targetConfig targets="lightning__FlowScreen">
12      <property name="startDate" label="Start Date" type="Date" role="inputOnly" />
13      <property name="account" label="Account Chosen" type="@salesforce/schema/Account" />
14      <property name="annualRevenue" label="Annual Revenue" type="Integer" role="outputOnly" />
15      <property name="name" label="Account Name" type="String" />
16    </targetConfig>
17  </targetConfigs>
18</LightningComponentBundle>

関連トピック

XML 設定ファイルの要素

The Japanese Summer '24 guide is now live

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