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

NameTypeDescription
utilityIdstringThe ID of the utility to open. Optional when called within a utility.
enableModalModebooleanWhether to enable modal mode.

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:

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