This folder contains a collection of Lightning Components and Invocable Actions that can be used to enhance Lightning Flow from Salesforce. Note that you do not need to write code, read code, or use developer console to install these into your Flow Builder! You can install many of these components as packages over at UnofficialSF site. (See "Installation")
Lightning Flow Screen Components
/flow_screen_components contains lightning components (a mix of aura and lwc) that have been optimized to be inserted into Lightning Flow screens. This mainly means that they:
- implement the Flow Screen interface. This causes them to appear in the palette of the Screen Builder in Flow Builder, where they can be dragged into Screen Nodes.
- explicitly specify which component attributes will be visible as inputs or outputs in Flow.
Flow Screen Components generally have a visual focus, although they don't absolutely have to.
Lightning Flow Actions
/flow_action_components contains Apex classes and Lightning Components that have been optimized to be added to Lightning Flows as standalone actions.
The Apex Classes are Invocable Actions. They are non-visual and execute entirely in the Salesforce cloud.
Lightning Components that are designed to act as actions are referred to as Local actions.
This mainly means that they:
- implement the "flowruntime:availableForLocalInvocableActions" interface so they show up in the tools palette of Flow Buider as Local Actions that can be dragged onto the canvas and added to flows as discrete nodes.
- provide an #invoke method that allows the Flow engine to call them at the appropriate point during flow execution, and make a callback to the Flow engine when they're done.
Important Setup Notes
Before adding any lightning component to your flow, your org must be enabled for lightning components. This means:
- you must have My Domain enabled and deployed
- you must have the "Enable Lightning Runtime for Flows" checkbox enabled in Setup - Process Automation Settings
You do not need to be using the lightning experience to use these flow extensions.
Have you built a useful or interesting Flow Component? We encourage you to make a pull request and add it to this repo. Also feel free to enhance or fix any existing component. General conversations about the components is carried out in the Issues section above or at the Salesforce Automation Trailblazer Community.