Salesforce Console Developer Guide
jWinter '27 preview (API version 68.0)
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)
Using Background Utility Items
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
disableUtilityPopOut()
enableModal()
enablePopout()
getAllUtilityInfo()
getEnclosingUtilityId()
getInfo()
getUtilityInfo()
isUtilityPoppedOut()
minimize()
minimizeUtility()
onUtilityClick()
open()
openUtility()
setPanelHeaderIcon()
setPanelHeaderLabel()
setPanelHeight()
setPanelWidth()
setUtilityHighlighted()
setUtilityIcon()
setUtilityLabel()
toggleModalMode()
updatePanel()
updateUtility()
EnclosingUtilityId Wire Adapter
Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Methods for the Utility Bar in Lightning Experience
The utility bar houses Aura components and Lightning web components, providing users
quick access to tools they use often. The utility bar is available in Lightning Experience only.
Both Lightning Web Components (LWC) and Aura Components support the utility bar methods, with
usage differences noted on each method.
To understand how the utility bar methods for LWC map to the methods for Aura Components, see Utility Bar API Method Parity.
These methods are available for working with the utility bar.
-
disableUtilityPopOut() for Lightning Experience
Disables pop-out for a utility. This method isn’t supported for Lightning Web Components (LWC). -
enableModal() 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. This method is available for Lightning Web Components (LWC) only. -
enablePopout() for Lightning Experience
Toggles pop-out mode on a utility. Enabling pop-out mode on a utility displays the utility in a separate child window. This method is available for Lightning Web Components (LWC) only. -
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. This method isn’t supported for Lightning Web Components (LWC). -
getInfo() for Lightning Experience
Returns the state of the current utility as a utilityInfo object. This method is available for Lightning Web Components (LWC) only. -
getUtilityInfo() for Lightning Experience
Returns the state of the current utility as a utilityInfo object. This method isn’t supported for Lightning Web Components (LWC). -
isUtilityPoppedOut() for Lightning Experience
Determines whether the utility is in a popped-out state. This method isn’t supported for Lightning Web Components (LWC). -
minimize() for Lightning Experience
Minimizes a utility. This method is available for Lightning Web Components (LWC) only. -
minimizeUtility() for Lightning Experience
Minimizes a utility. This method isn’t supported for Lightning Web Components (LWC). -
onUtilityClick() for Lightning Experience
Registers an eventHandler for the utility. This eventHandler is called when the utility is clicked. -
open() 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, open() minimizes the utility. This method is available for Lightning Web Components (LWC) only. -
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, openUtility() minimizes the utility. This method isn’t supported for Lightning Web Components (LWC). -
setPanelHeaderIcon() for Lightning Experience
Sets the icon of a utility’s panel. This icon is displayed in the utility panel header. This method isn’t supported for Lightning Web Components (LWC). -
setPanelHeaderLabel() for Lightning Experience
Sets the label of a utility’s panel. This label is displayed in the utility panel header. This method isn’t supported for Lightning Web Components (LWC). -
setPanelHeight() for Lightning Experience
Sets a utility panel’s height. This method isn’t supported for Lightning Web Components (LWC). -
setPanelWidth() for Lightning Experience
Sets a utility panel’s width. This method isn’t supported for Lightning Web Components (LWC). -
setUtilityHighlighted() for Lightning Experience
Sets a utility as highlighted, giving it a badge and a more prominent background color. This method isn’t supported for Lightning Web Components (LWC). -
setUtilityIcon() for Lightning Experience
Sets the icon of a utility. This icon is displayed in the utility bar. This method isn’t supported for Lightning Web Components (LWC). -
setUtilityLabel() for Lightning Experience
Sets the label of a utility. This text is displayed in the utility bar. This method isn’t supported for Lightning Web Components (LWC). -
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. This method isn’t supported for Lightning Web Components (LWC). -
updatePanel() for Lightning Experience
Specifies a label and icon on the utility panel, and provides a height and width for the panel. This method is available for Lightning Web Components (LWC) only. -
updateUtility() for Lightning Experience
Specifies a label and icon on the utility bar, and sets a utility as highlighted. This method is available for Lightning Web Components (LWC) only. -
EnclosingUtilityId Context Wire Adapter for Lightning Experience
Determines if the component is within a utility. This wire adapter is available for Lightning Web Components (LWC) only.