Lightning Components Developer Guide
jNewer Version Available
lightning:availableForFlowScreens
Add the lightning:availableForFlowScreens interface to a Lightning component to make it
available for flow screens. This interface is supported only in Lightning
runtime.
This interface is a marker interface. A marker interface signals the component’s container to add the interface’s behavior to the component. You don’t need to implement methods or attributes in your component. Instead, you just add the interface name to the component’s implements attribute.
Example
This example shows the markup required to add the lightning:availableForFlowScreens interface to a Lightning component.
1<aura:component implements="lightning:availableForFlowScreens">
2
3 <!-- ... -->
4
5</aura:component>For more information, see Customize Flow Screens By Using Lightning Components.
Attributes
| Attribute Name | Type | Description | Required? |
|---|---|---|---|
| availableActions | String[] | The navigation actions available for this screen. Valid actions are Next, Previous, Finish, and Pause. | |
| navigateFlow | action | References the appropriate navigation action to move away from this screen. | |
| screenHelpText | String | Help text for this screen. |