Salesforce Console Developer Guide
jWinter '27 preview (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
Using Background Utility Items
Using Events with the Lightning Console JavaScript API
Use Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
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
Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Methods for Workspace Tabs and Subtabs in Lightning Experience
A Lightning console app
displays Salesforce pages as workspace
tabs or subtabs. A workspace tab displays the main work item or record, such as an account.
A subtab displays related records, such as an account’s contacts or
opportunities.
These methods work with workspace tabs and subtabs in Lightning console apps. Both Lightning Web Components (LWC) and Aura Components are supported unless otherwise specified.
Keep in mind that tabIds are case sensitive.
Note
-
addToBrowserTitleQueue() for Lightning Experience
Adds a string to a list of titles that rotate in the browser title bar every three seconds.This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
closeTab() for Lightning Experience
Closes a workspace tab or subtab. This method works only in Lightning console apps. -
disableTabClose() for Lightning Experience
Prevents a workspace tab or subtab from closing. This method removes the close button from a tab or subtab, and disables the keyboard shortcuts that close tabs and subtabs. This method works only in Lightning console apps. -
focusTab() for Lightning Experience
Focuses a workspace tab or subtab. This method works only in Lightning console apps. -
generateConsoleUrl() for Lightning Experience
Generates a URL for a workspace tab and its subtabs. This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
getAllTabInfo() for Lightning Experience
Returns information about all open tabs. This method works only in Lightning console apps. -
getEnclosingTabId() for Lightning Experience
Returns the ID of the enclosing tab. This method isn’t supported for Lightning Web Components (LWC). -
getFocusedTabInfo() for Lightning Experience
Returns information about the focused workspace tab or subtab. This method works only in Lightning console apps. -
getTabInfo() for Lightning Experience
Returns information about the specified tab. This method works only in Lightning console apps. -
getTabURL() for Lightning Experience
Returns the URL of the specified tab. This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
isConsoleNavigation() for Lightning Experience
Determines whether the app it’s used within uses console navigation. This method isn’t supported for Lightning Web Components (LWC). -
isSubtab() for Lightning Experience
Checks whether a tab is a subtab. This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
openConsoleUrl() for Lightning Experience
Opens a URL generated by generateConsoleUrl(). This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
openSubtab() for Lightning Experience
Opens a subtab within a workspace tab. If the subtab is already open, the subtab is focused. This method works only in Lightning console apps. -
openTab() for Lightning Experience
Opens a new workspace tab. If the tab is already open, the tab is focused. -
refreshTab() for Lightning Experience
Refreshes a workspace tab or a subtab specified by tabId. Keep in mind that the first subtab has the same tabId as the workspace tab. This method works only in Lightning console apps. -
removeFromBrowserTitleQueue() for Lightning Experience
Removes a string from a list of titles that rotate in the browser title bar every three seconds. This method works only in Lightning console apps. This method isn’t supported for Lightning Web Components (LWC). -
setTabHighlighted() for Lightning Experience
Highlights the specified tab with a different background color and a badge. Tab highlights don’t persist after reloading a Lightning console app. This method works only in Lightning console apps. -
setTabIcon() for Lightning Experience
Sets the icon and alternative text of the specified tab. This method works only in Lightning console apps. -
setTabLabel() for Lightning Experience
Sets the label of the specified tab. This method works only in Lightning console apps. -
EnclosingTabId Context Wire Adapter for Lightning Experience
Returns the ID of the enclosing tab or subtab. This wire adapter is available for Lightning Web Components (LWC) only. -
IsConsoleNavigation Context Wire Adapter for Lightning Experience
Determines whether the app it’s used within uses console navigation. This wire adapter is available for Lightning Web Components (LWC) only.