enablePopout() for Lightning Experience

Toggles pop-out mode on a utility. Enabling pop-out mode on a utility displays the utility in a separate child window. This method is available for Lightning Web Components (LWC) only.

Optional parameters are passed into an object as the last argument of the method.

NameTypeDescription
utilityIdstringThe ID of the utility for which to toggle pop-out mode.
enabledbooleanSpecifies whether to enable the utility’s modal mode.
disabledTextstringOptional. Hover text for pop-out button when the utility is not enabled for pop-out 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.