Considerations for Configuring Components for Flows

Before you configure an Aura component for a flow, determine whether it should be available in flow screens or as flow actions and understand how to map data types between a flow and an Aura component. Then review some considerations for defining attributes and how components behave in flows at runtime.

• Lightning components in flows must comply with Lightning Locker restrictions.

• Flows that include Lightning components are supported only in Lightning runtime.

• Flow Screen Components vs. Flow Action Components

  You can make your Aura component available in flow screens or as a flow action. When choosing between the flow interfaces, consider what purpose the component serves in the flow.

• Which Custom Lightning Component Attribute Types Are Supported in Flows?

  Not all custom Lightning component data types are supported in flows. You can map only these types and their associated collection types between flows and custom Lightning components.

• Design Attribute Considerations for Flow Screen Components and Local Actions

  To expose an attribute in Flow Builder, define a corresponding design:attribute in the component bundle’s design resource. Keep these guidelines in mind when defining design attributes for flows.

• Runtime Considerations for Flows That Include Aura Components

  Depending on where you run your flow, Aura components may look or behave differently than expected. The flow runtime app that’s used for some distribution methods doesn’t include all the necessary resources from the Lightning Component framework. When a flow is run from Flow Builder or a direct flow URL (https://yourDomain.my.salesforce.com/flow/MyFlowName), force and lightning events aren’t handled.

See Also

• Component Library: lightning:availableForFlowScreens Interface

• Component Library: lightning:availableForFlowActions Interface

• Security for Lightning Components: Lightning Locker