Flow Support
lightning/flowSupport
Controls flow navigation and notifies the flow of changes in attribute values.
For Use In
Lightning Experience
The lightning/flowSupport module provides events that enable a component to control flow navigation and notify the flow of changes in attribute values.
The events are supported only in components where the target is lightning__FlowScreen.
Events include:
FlowAttributeChangeEvent— Informs the runtime that a component property has changed.FlowNavigationBackEvent— Requests navigation to the previous screen.FlowNavigationNextEvent— Requests navigation to the next screen.FlowNavigationPauseEvent— Requests the flow runtime to pause the flow.FlowNavigationFinishEvent— Requests the flow runtime to terminate the flow.
This example toDos component includes the lightning__FlowScreen target and sets a property in its toDos.js-meta.xml file.
The example toDos component template includes buttons that work with the flow.
The component uses the FlowAttributeChangeEvent and FlowNavigationNextEvent events from lightning/flowSupport in JavaScript.