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
Methods for Workspace Tabs and Subtabs
addToBrowserTitleQueue()
closeTab()
disableTabClose()
focusTab()
generateConsoleUrl()
getAllTabInfo()
getEnclosingTabId()
getFocusedTabInfo()
getTabInfo()
getTabURL()
isConsoleNavigation()
isSubtab()
openConsoleUrl()
openSubtab()
openTab()
refreshTab()
removeFromBrowserTitleQueue()
setTabHighlighted()
setTabIcon()
setTabLabel()
EnclosingTabId Wire Adapter
IsConsoleNavigation Wire Adapter
Methods for the Utility Bar
LWC Methods for Enhanced Messaging
Aura 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

openTab() for Lightning Experience

Opens a new workspace tab. If the tab is already open, the tab is focused.

Arguments

The method provides the same argument for both Aura Components and Lightning Web Components (LWC). However, icon, iconAlt, and label are supported only for LWC.

Name Type Description
pageReference object Optional. Generates a unique URL to open. A page reference contains attributes that apply to all pages of that type. See the Aura pageReference types and LWC pageReference types.
recordId ID Optional. Specifies the record to open.
url URL

Optional. The URL representing the content of the new workspace tab.

The URL can be either relative or absolute. To use a third-party domain, add the site as a CSP Trusted Site.
focus boolean Optional. Specifies whether the new tab has focus. To display the tab immediately, set focus to true. To open the tab in the background, set focus to false.
overrideNavRules boolean Optional. Specifies whether the open tab respects existing navigation rules. This argument has no effect on records that have no navigation rules configured and URLs that do not point to a record.
icon string Optional. An SLDS icon key in the format action:canvas where action is the SLDS icon category. See a full list of icon categories and keys on the SLDS reference site. Available for LWC only.
iconAlt string Optional. Alternative text for the icon. Available for LWC only.
label string Optional. The text label for the icon. Available for LWC only.

pageReference, recordId, and url are prioritized in that order. Providing an argument with a higher priority means the others are ignored.

Note

LWC Sample Code

This component has a function that opens a specified tab and applies focus on it.

For another example that uses openTab(), see the workspaceAPIOpenTab component in the lwc-recipes repo.

To make your component available for use in a Lightning console app, specify the lightning__AppPage target in the component’s configuration file.

Aura Components Sample Code

This component has a button that when pressed, opens a tab.

Component code:
Pass in a pageReference Controller code (pageReference) using the standard__recordPage type:
Controller code (recordId):
Controller code (url):

The relative URL used in this example is a placeholder. To try this example yourself, use a relative URL with a record ID from your org.

Note

Response

This method returns a promise that, upon success, resolves to the tabId of the new tab.