Path (Beta)

lightning:path

Displays a path driven by a picklist field and Path Setup metadata. This component requires API 41.0 and later. For Aura components only.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App

A lightning:path component displays the progress of a process, which is based on the picklist field that's specified by Path Settings in Setup. The path is rendered as a horizontal bar with a chevron for each picklist item. The key fields and guidance for success are displayed below the path.

This example changes the path variant depending on which stage is clicked.

The client-side controller displays a toast with the step name that's clicked.

If an invalid attribute value is used, an error is displayed in place of the component.

Implementing the force:hasRecordId interfaces provides the record Id of the record that's currently viewed to the component. To make your component available in Lightning App Builder, implement the flexipage:availableForAllPageTypes interface, which enables admins to drag-and-drop the component onto a Lightning page easily.

To use a path component in the Salesforce app, display it in a custom tab.