Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
How are the Classic and Lightning Console APIs Different?
Lightning Console JavaScript API
Syntax Syntax
Using Background Utility Items
Using Pop-Out Utilities
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
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

setTabIcon() for Lightning Experience

Sets the icon and alternative text of the specified tab. This method works only in Lightning console apps.

Arguments

Name Type Description
tabId string The ID of the tab for which to set the icon.
icon string An SLDS icon key in the format utility:iconName where utility is the icon category. See a full list of utility icons on the SLDS reference site.
iconAlt string Optional. Alternative text for the icon.

LWC Sample Code

This component has a function that sets an icon on a specified tab. It uses the tabId property from getFocusedTabInfo().

For another example that uses setTabIcon(), see the workspaceAPISetTabIcon 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, sets the icon of the focused tab to the SLDS “Approval” action icon.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to a tabInfo object representing the modified 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.