Navigation Button (LIGHTNING ONLY)
This is a standard button that can, when put on a flow screen and clicked, carry out several useful flow behaviors.
NOTE: This component uses force events technology that only runs in true Lightning Experience. It will not run in:
- Classic mode, even if you use the Flow Lightning Runtime
- the run and debug buttons in the Flows Setup screen (even if you are otherwise in Lightning Experience! This is because the Setup screen is still in Classic mode, as you can see if you look at how it renders buttons.
Watch the Upgrade Video showing how you can find out whether the button was clicked.
8/23/21 – Eric Smith
If you want to add a Cancel button to a Screen that has required input fields you should use either of the following configurations:
- If the Flow has a prior screen, use Target Type standard and Navigation Type back
- If there is no prior screen, use Target Type record and provide the recordId of the current record
3/26/21 Update: Up to 5 buttons and a new attribute to Right Justify the buttons
4/29/19 Update: You now have the option to display a button as disabled
3/10/19 Update: Now 3 Buttons. Each attribute is now preceded by a B1_, B2_, or B3_ for the first, second (optional), or third (optional) button.
1/23/19 Update: You can now set B1_Variant Type and/or B2_Variant Type. Valid entries are base, neutral, brand, destructive or success. The default value is neutral.
12/3/18 Update: Each attribute is now preceded by a B1_ or B2 for the first or second (optional) button.
Start by setting Target Type to either “url”, “record”, or “standard”. Standard will cause a standard transition to next, previous or finish in the flow. Record will go to the place specified in the Target RecordId field, and url will go to the place specified in Target Destination.
If you use standard, set NavigationType to “next”, “finish”, or “back”
You can also set the button label.
If you want to know, later in the flow, whether the button was clicked or not, add the Button Clicked? attribute to your Output tab, and map it to Variable of type Boolean. You can then check the value at any time. This is described in this demo video.
Remember: if you try to test this by running it from the Setup page or the debugger or the Cloud Flow Designer it will fail because of a problem that is scheduled to be fixed in Summer ’19. To test it or run it, add a Flow component to a lightning page and set the Flow component to run this Flow (don’t forget to activate the flow first!).
Installation Version 1.6 – Install in Production
Sandbox Version 1.6 – Install in a Sandbox
3/26/21: Version 1.6 – Now supports 5 buttons and right justification of the button group (Updated by Eric Smith – March 2021)
4/29/19: Now supports displaying buttons as disabled (Updated by Eric Smith – March 2019)
Installation – Install in Production
Sandbox – Install in a Sandbox
3/10/19: Now supports 3 buttons (Updated by Eric Smith – March 2019)
1/23/19: Added support for button variant styling (Updated by Eric Smith – January 2019)
12/3/18: Now supports dual buttons (Updated by Eric Smith – December 2018)
11/18: exposed a Button Clicked? boolean attribute that can be used downstream in the flow to tell whether the button was clicked.