enableModal() 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 is available for Lightning Web Components (LWC) only.

NameTypeDescription
utilityIdstringThe ID of the utility for which to toggle modal mode.
enabledbooleanSpecifies whether to enable the utility’s modal mode.

This component toggles modal mode in a utility bar.

To make your component available for use in a utility bar, specify the lightning__UtilityBar target in the component’s configuration file.

Returns a promise that resolves to true if successful. The promise is rejected on error.