カスタム Lightning Web コンポーネントの作成と起動

画面フローを作成して、任意の Lightning Web コンポーネントから起動します。

lightning-flow は Lightning ランタイムでのフローインタビューを表します。コンポーネントでフローを作成するには、lightning-flow コンポーネントの flow-api-name 属性に、使用するフローの API 名を設定します。このコンポーネントを使用するには、その前に、Salesforce Flow Builder でフローを作成します。このコンポーネントには、戻る、次へ、一時停止、完了のナビゲーションボタンが含まれています。

フローに、カスタムの Lightning Web コンポーネントまたは Aura コンポーネントがある場合、Lightning Web Runtime を使用する Experience Cloud サイトで lightning-flow を使用することができません。

この例では、Survey Customers フローを作成して開始します。

flow-input-variables 属性に配列の入力値を設定することで、インタビューのための初期入力を指定できます。

この例では、フローの初期値を渡すことで、インタビューを作成し、開始します。onstatuschange イベントハンドラを使用して、インタビューの変更を処理します。

lightning-flow コンポーネントは、flow-api-name 属性の有効なフローのみをサポートします。

onstatuschange イベントは次のパラメータを返します。

パラメータ	型	説明
activeStages	Object[]	フローの $Flow.ActiveStages 変数の現在の値。API バージョン 42.0 以降で利用できます。
currentStage	Object	フローの $Flow.CurrentStage 変数の現在の値。API バージョン 42.0 以降で利用できます。
flowTitle	String	フローの表示ラベル。
helpText	String	現在の画面のヘルプテキスト。API バージョン 42.0 以降で利用できます。
guid	String	インタビューの GUID。API バージョン 42.0 以降で利用できます。
outputVariables	Object[]	フローの出力変数の現在の値。
status	String	インタビューの状況。フローインタビューの有効な状況は、次のとおりです。 `STARTED`: インタビューは正常に開始しました。 `PAUSED`: インタビューは正常に一時停止しました。 `FINISHED`: 画面を伴うフローのインタビューが完了しました。 `FINISHED_SCREEN:` 画面を伴わないフローのインタビューが完了し、コンポーネントは「フローが終了しました」というメッセージのデフォルト画面を表示しています。 `ERROR`: 問題が発生して、インタビューに失敗しました。

各フローコンポーネントには、戻る、次へ、一時停止、完了のナビゲーションボタンが含まれており、フロー内を移動できます。デフォルトでは、フローが完了すると、コンポーネントは新しいインタビューの最初の画面を再読み込みします。フローが完了したときの動作をカスタマイズするには、状況が FINISHED の場合の onstatuschange アクションのイベントハンドラを追加します。