Picklist Path (Beta)

A lightning:picklistPath component displays the progress of a process, which is based on the picklist field specified by the picklistFieldApiName attribute. The path is rendered as a horizontal bar with one chevron for each picklist item. Paths created by this component do not have key fields or guidance and do not display the Mark Complete button.

This example creates a path for contact records that's based on the record ID and the LeadSource picklist field.

Clicking a step in the path displays a toast with the step name that's clicked.

To create a path based on forecast categories, use the ForecastCategoryName field.

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.

On mobile devices, labels on the chevrons are truncated, and the label for the currently selected item is displayed below the horizontal bar.