Salesforce Console Developer Guide
jNote: 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.
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:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Toggle Modal Mode" onclick="{! c.handleToggleModalMode }" />
4</aura:component>Controller code:
1({
2 handleToggleModalMode : function(component, event, helper) {
3 var utilityAPI = component.find("utilitybar");
4 utilityAPI.toggleModalMode({
5 enableModalMode: true
6 });
7 }
8})Response
This method returns a promise that, upon success, resolves to true.