Lightning Aura Components Developer Guide

Introducing Aura Components
Quick Start
Creating Components
Using Components
Aura Component Bundle Design Resources
Use Aura Components in Lightning Experience and the Salesforce Mobile App
Navigate Across Your Apps with Page References
Get Your Aura Components Ready to Use on Lightning Pages
Use Aura Components in Experience Builder
Use Aura Components with Flows
Considerations for Configuring Components for Flows
Flow Screen Components vs. Flow Action Components
Which Custom Lightning Component Attribute Types Are Supported in Flows?
Design Attribute Considerations for Flow Screen Components and Local Actions
Runtime Considerations for Flows That Include Aura Components
Customize Flow Screens Using Aura Components
Create Flow Local Actions Using Aura Components
Embed a Flow in a Custom Aura Component
Display Flow Stages with an Aura Component
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Use Aura and Lightning Web Components Outside of Salesforce with Lightning Out (Beta)
Lightning Container
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components
Debugging
Performance
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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.
Flow Data Type Lightning Component Attribute Type Valid Values
Apex Custom Apex Class Apex classes that define @AuraEnabled fields. Supported data types in an Apex class are Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values as well as Lists are supported for each data type.
Boolean Boolean
  • True values: true, 1, or equivalent expression
  • False values: false, 0, or equivalent expression
Currency Number Numeric value or equivalent expression
Date Date "YYYY-MM-DD" or equivalent expression
Date/Time (API name is DateTime) DateTime "YYYY-MM-DDThh:mm:ssZ" or equivalent expression
Number Number Numeric value or equivalent expression
Multi-Select Picklist

(API name is Multi-Select Picklist.)

 String String value or equivalent expression using this format:

"Blue; Green; Yellow"
Picklist String String value or equivalent expression
Record, with a specified object

(API name is SObject.)

 The API name of the specified object, such as Account or Case Map of key-value pairs or equivalent expression.

Flow record values map only to attributes whose type is the specific object. For example, an account record variable can be mapped only to an attribute whose type is Account. Flow data types aren’t compatible with attributes whose type is Object.
Text

(API name is Text.)

 String String value or equivalent expression
Time Time "hh:mm:ss.SSSZ" or equivalent expression