Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
How are the Classic and Lightning Console APIs Different?
Lightning Console JavaScript API
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
Using Events with the Lightning Console JavaScript API
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods
Methods for Navigation Items
focusNavigationItem()
getNavigationItems()
getSelectedNavigationItem()
refreshNavigationItem()
setSelectedNavigationItem()
Methods for Workspace Tabs and Subtabs
Methods for the Utility Bar
Methods for Enhanced Messaging
Methods for Chat
Methods for Omni-Channel
Events
Salesforce Classic API
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

focusNavigationItem() for Lightning Experience

Focuses on the selected navigation object and opens the object's home page. Typically, standard and custom objects open the object's list view. If split view is open, focus remains on the selected navigation object. This method works only in Lightning console apps.
Keep these things in mind when working with this method.
  • If a tab is already open for the navigation item, the focus is set on the tab.
  • If split view is open, the focus is set on the navigation tab.
  • If split view is collapsed, the navigation item’s tab is opened and focus is set on the tab.

Arguments

None

Sample Code

This component has a button that, when pressed, focuses on the navigation item and opens the navigation item’s home page. For most objects, the home page is the object’s list view.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to true. The promise is rejected on error.