Salesforce Docs Portal

Embed a Screen Flow in a Lightning Page

To easily distribute a screen flow to Lightning Experience or Salesforce app users, embed it in a Lightning page.

Required Editions

Available in: Lightning Experience
Available in: Essentials, Professional, Enterprise, Performance, Unlimited, and Developer Editions
User Permissions Needed
To create and save Lightning pages in the Lightning App Builder: Customize Application

If you’re not yet familiar with the types of Lightning pages you can customize, check out the Lightning App Builder module in Trailhead. ​If your org uses the Outlook or Gmail integrations you can ​also create custom email application panes.

  1. Open a Lightning page in the Lightning App Builder.
  2. From the Lightning Components pane on the left, drag the Flow component onto the Lightning page canvas.
  3. Configure the component.
    Component Description
    Flow Only active screen flows are available. Flows that were built in the Desktop Flow Designer aren’t supported.
    Layout

    By default, flows display in one column.

    If a screen contains a Section screen component, that screen ignores the Layout property.

    • Starting in Winter ’23, two-column flow layouts are ignored. For a better layout option, add Section components to your flow screens. Each Section component lets you organize record fields and screen components in up to four adjustable-width columns.
    • If a flow screen contains a Section component, that screen ignores the Layout property.
    Input variables If you see other properties, they’re the flow’s input variables. Variables appear only if they allow input access.
    Pass all field values from the record into the flow variable

    This option is available only for Record pages, and requires a record variable in the flow named recordId that's available for input.

    For example, when this component is embedded in an Contact Record page, at run time the component passes the contact's record into the recordId input record variable.

    Pass record ID into this variable

    This option is available only for Record pages, and requires a text variable in the flow named recordId that's available for input.

    For example, when this component is embedded in an Opportunity Record page, at run time the component passes the opportunity’s ID into the recordId input text variable.

  4. Save the page.
  5. Hang on, you’re not finished yet! To make your page available to your users, activate it. You can activate the page from the Save dialog when you save it for the first time, or later using the Activation button.
  6. Test that the flow is working correctly, and then roll the Lightning page out to your users.

See Also