Salesforce Console Developer Guide

Salesforce Console Developer Guide
How are the Classic and Lightning APIs Different?
Lightning Experience API
Get to Know the Lightning Console
Get to Know the Utility Bar
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Events in Lightning Console Apps
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods for Lightning Experience
Methods for Navigation Items
Methods for Workspace Tabs and Subtabs
closeTab()
disableTabClose()
focusTab()
generateConsoleUrl()
getAllTabInfo()
getEnclosingTabId()
getFocusedTabInfo()
getTabInfo()
getTabURL()
isConsoleNavigation()
isSubtab()
openConsoleUrl()
openSubtab()
openTab()
refreshTab()
setTabHighlighted()
setTabIcon()
setTabLabel()
Methods for the Utility Bar
Methods for Omni-Channel
Events for Lightning Experience
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. See a full list of icon keys on the SLDS reference site.
iconAlt string Optional. Alternative text for the icon.

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.