---
schema_version: "1"
id: 6f2b66847ea8353bba55335da97338deb7cc5bf3c91183c54ae1c600ce1571b1
title: Platform Navigation Item API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/lightning-base-components/lightning-design-system/guides/lwc/components/lightning/platformNavigationItemApi/lightning-platform-navigation-item-api.md
canonical_url: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-platform-navigation-item-api.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 937c778e6e27eb44cb07cfb246c5099bb968615831980065b4fe00719e919e20
products:
  - Lightning Component Reference
---
# Platform Navigation Item API

**`lightning/platformNavigationItemApi`**

Work with navigation items in the menu of a Lightning console app by using the `lightning/platformNavigationItemApi` module. The `lightning/platformNavigationItemApi` module requires API version 67.0 or later.

**For Use In**

Lightning Experience

::::::tabset{tabs='[ "Develop", "Specifications" ]'}

:::::tab
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.

```javascript
import {
  focusNavigationItem,
  getNavigationItems,
  getSelectedNavigationItem,
  refreshNavigationItem,
  setSelectedNavigationItem,
} from "lightning/platformNavigationItemApi";
```

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

```javascript
// c/myComponent.js
import { LightningElement, wire } from "lwc";
import {
  IsConsoleNavigation,
  setSelectedNavigationItem,
} from "lightning/platformNavigationItemApi";

export default class MyComponent extends LightningElement {
  @wire(IsConsoleNavigation) isConsoleNavigation;

  onSelectAccounts(event) {
    if (!this.isConsoleNavigation) {
      return;
    }
    setSelectedNavigationItem("standard-Account").then((isSelected) => {
      console.log(
        `Select navigation item ${isSelected ? "successfully" : "failed"}`,
      );
    });
  }
}
```

For this module's documentation, see [Methods for Navigation Items in Lightning Experience](https://developer.salesforce.com/docs/atlas.en-us.api_console.meta/api_console/sforce_api_console_methods_lightning_navigationItemAPI.htm) in the Console Developer Guide.

:::::

:::::tab
::component-specification{component="platformNavigationItemApi" model="lwc" namespace="lightning"}

:::::

::::::