Salesforce Console Developer Guide

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

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.