Salesforce Console Developer Guide

What Is the Console Developer Guide?
Why Your UI Matters
Lightning Console JavaScript API for Lightning Experience
Salesforce Console Integration Toolkit for Salesforce Classic
Methods for Salesforce Classic
Methods for Lightning Experience
Methods for Workspace Tabs and Subtabs
closeTab()
focusTab()
getAllTabInfo()
getEnclosingTabId()
getFocusedTabInfo()
getTabInfo()
getTabURL()
isConsoleNavigation()
isSubtab()
openSubtab()
openTab()
setTabHighlighted()
setTabIcon()
setTabLabel()
Methods for the Utility Bar
Methods for Omni-Channel (Beta)
Events for Lightning Experience
Other Resources
PDF

Newer Version Available

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

closeTab() for Lightning Experience

Closes a workspace tab or subtab. This method works only in Lightning console apps.

Arguments

Name Type Description
tabId string ID of the workspace tab or subtab to close.

Sample Code

This component has a button that, when pressed, closes the currently focused tab.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to a tabInfo object representing the closed tab. A tabInfo object is a JSON array of information about a workspace tab, with nested arrays of information on each subtab. This is the structure of a tabInfo object.