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 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
Methods for the Utility Bar
getAllUtilityInfo()
getEnclosingUtilityId()
getUtilityInfo()
minimizeUtility()
onUtilityClick()
openUtility()
setPanelHeaderIcon()
setPanelHeaderLabel()
setPanelHeight()
setPanelWidth()
setUtilityHighlighted()
setUtilityIcon()
setUtilityLabel()
toggleModalMode()
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

setUtilityIcon() for Lightning Experience

Sets the icon of a utility. This icon is displayed in the utility bar.

Arguments

Name Type Description
utilityId string The ID of the utility on which to set the icon. Optional when called within a utility.
icon string An SLDS utility icon key that is displayed in the utility bar. See a full list of utility icon keys on the SLDS reference site.

Sample Code

This component, when added to a single-column Lightning page used in a utility bar, sets the icon of the utility to the SLDS “insert_tag_field” icon when the button is pressed.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to true.