Platform Navigation Item API

The lightning/platformNavigationItemApi module provides methods to control navigation items in the menu of a Lightning console app. All the methods return a promise. The setSelectedNavigationItem method requires the navigation item’s developerName to be passed as an argument. The other methods take no arguments.

To use the Navigation Item API in your component, import the functions in your component’s JavaScript file.

This example selects the Accounts navigation item in the Lightning console app.

For this module’s documentation, see Methods for Navigation Items in Lightning Experience in the Console Developer Guide.