Salesforce Console Developer Guide
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)
What Is the Console Developer Guide?
getAllUtilityInfo()
getEnclosingUtilityId()
getUtilityInfo()
minimizeUtility()
openUtility()
setPanelHeaderIcon()
setPanelHeaderLabel()
setPanelHeight()
setPanelWidth()
setUtilityHighlighted()
setUtilityIcon()
setUtilityLabel()
toggleModalMode()
Newer Version Available
Methods for the Utility Bar in Lightning Experience
The utility bar houses Lightning components, and gives your users quick access to tools
they use often. The utility bar is available in Lightning Experience only.
These methods work in the utility bar.
-
getAllUtilityInfo() for Lightning Experience
Returns the state of all utilities as an array of utilityInfo objects. -
getEnclosingUtilityId() for Lightning Experience
Returns the ID of the enclosing utility, or false if not within a utility. -
getUtilityInfo() for Lightning Experience
Returns the state of the current utility as a utilityInfo object. -
minimizeUtility() for Lightning Experience
Minimizes a utility. -
openUtility() for Lightning Experience
Opens a utility. If the utility is already open, this method has no effect. Only one utility can be open at a time. If another utility is already open, it is minimized. -
setPanelHeaderIcon() for Lightning Experience
Sets the icon of a utility’s panel. This icon is displayed in the utility panel header. -
setPanelHeaderLabel() for Lightning Experience
Sets the label of a utility’s panel. This label is displayed in the utility panel header. -
setPanelHeight() for Lightning Experience
Sets a utility panel’s height. -
setPanelWidth() for Lightning Experience
Sets a utility panel’s width. -
setUtilityHighlighted() for Lightning Experience
Sets a utility as highlighted, giving it a badge and a more prominent background color. -
setUtilityIcon() for Lightning Experience
Sets the icon of a utility. This icon is displayed in the utility bar. -
setUtilityLabel() for Lightning Experience
Sets the label of a utility. This text is displayed in the utility bar. -
toggleModalMode() for Lightning Experience
Toggles modal mode for a utility. While in modal mode, an overlay blocks users from using the console while the utility panel is visible.