Skip to content

Latest commit

 

History

History
executable file
·
60 lines (37 loc) · 2.11 KB

sfpegFlowLaunchCmpLegacy.md

File metadata and controls

executable file
·
60 lines (37 loc) · 2.11 KB
Raw

Logo   sfpegFlowLaunch_CMP (Legacy) Flow Launch Component

Introduction

This Aura component enables to trigger a Flow embedded within a page instead of a popup as with standard Quick Actions. Its main benefit compared to the standard Flow App Builder component providing similar functionality is to avoid loading and initialising the Flow definition at initial page rendering if the user does not necessarily need to launch the flow.

⚠️ This Aura component is now obsolete. Please use the new sfpegFlowLaunchCmp LWC version instead.

Component Configuration

Global Layout

By default, a single action button is displayed on the right.

Flow Launch Initial State

When the user clicks on the button, the component toggles in execution mode with the embedded Flow page displayed below a close icon button.

Flow Launch Execution State

Upon completion/closing of the flow, the component gets back to its original state (with a single button displayed).

Configuration

The component is easily configurable from the App Builder.

Flow Launch Configuration

As a baseline, the following elements are configurable

  • The Label and Variant of the action button to lauch the flow
  • The Developer Name of the Flow to execute (as Flow Name parameter)
  • Various flags to provide contextual information to the flow (as recordId and sObjectName input variables)
  • The ability to automatically trigger a page refresh upon flow completion./cancellation (especially useful when using Lightning conditional display)
  • Some CSS classes to tune the containing div appearance

Configuration Examples

To be completed

Technical Details

This component relies on the standard lightning:flow Aura base component to embed and execute a Flow in an Aura component. It listens to its state transitions to track its completion.