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
Use 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

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).

For LWC usage, see enableModal().

Arguments

Name Type Description
utilityId string The ID of the utility to open. Optional when called within a utility.
enableModalMode boolean Whether to enable modal mode.

Aura Components Sample Code

This component, when added to a single-column Lightning page used in a utility bar, has a button that, when pressed, toggles modal mode.

Component code:

Controller code:

Response

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