Supported APIs

A list of methods and events that support utility pop-out.

Custom events aren’t supported while a utility is popped out. If custom events are critical to your utility’s functionality, we recommend disabling pop-out for your utility.

Note

Lightning Web Components (LWC) doesn’t currently support working with background utility items.

Lightning Console JavaScript API Methods for Navigation Items

Methods	Supports Pop-Out	Notes
focusNavigationItem() for Lightning Experience
getNavigationItems() for Lightning Experience
getSelectedNavigationItem() for Lightning Experience
refreshNavigationItem() for Lightning Experience
setSelectedNavigationItem() for Lightning Experience

Lightning Console JavaScript API Methods for Workspace Tabs and Subtabs

Methods	Supports Pop-Out	Notes
closeTab() for Lightning Experience
disableTabClose() for Lightning Experience
focusTab() for Lightning Experience
generateConsoleUrl() for Lightning Experience
getAllTabInfo() for Lightning Experience
getEnclosingTabId() for Lightning Experience
getFocusedTabInfo() for Lightning Experience
getTabInfo() for Lightning Experience
getTabURL() for Lightning Experience
isConsoleNavigation() for Lightning Experience
isSubtab() for Lightning Experience
openConsoleUrl() for Lightning Experience
openSubtab() for Lightning Experience
openTab() for Lightning Experience
refreshTab() for Lightning Experience
setTabHighlighted() for Lightning Experience
setTabIcon() for Lightning Experience
setTabLabel() for Lightning Experience

Lightning Console JavaScript API Methods for the Utility Bar

Methods	Supports Pop-Out	Notes
getAllUtilityInfo() for Lightning Experience
getEnclosingUtilityId() for Lightning Experience
getUtilityInfo() for Lightning Experience
minimizeUtility() for Lightning Experience		Returns `false` when popped out
onUtilityClick() for Lightning Experience
openUtility() for Lightning Experience
setPanelHeaderIcon() for Lightning Experience
setPanelHeaderLabel() for Lightning Experience
setPanelHeight() for Lightning Experience
setPanelWidth() for Lightning Experience
setUtilityHighlighted() for Lightning Experience
setUtilityIcon() for Lightning Experience
setUtilityLabel() for Lightning Experience
toggleModalMode() for Lightning Experience

Lightning Console JavaScript API Events

Events	Supports Pop-Out	Notes
lightning:tabClosed
lightning:tabCreated
lightning:tabFocused
lightning:tabRefreshed
lightning:tabReplaced
lightning:tabUpdated

Salesforce Classic Console API Methods for Primary Tabs and Subtabs

Methods	Supports Pop-Out	Notes
isInConsole()

Salesforce Classic Console API Events

Events	Supports Pop-Out	Notes
removeEventListener()
fireEvent()		`fireEvent()` returns `success true` even when eventListeners for the given eventType are removed.
addEventListener()