disableUtilityPopOut() for Lightning Experience

Disables pop-out for a utility. This method isn’t supported for Lightning Web Components (LWC).

For LWC usage, see enablePopout().

Arguments

Name	Type	Description
utilityId	string	The ID of the utility to disable pop-out for. Optional when called within a utility.
disabled	boolean	If true, disables pop-out and removes the pop-out icon for a utility that isn’t popped out. If the utility is already popped out, the pop-out icon is disabled. If `disabledText` is provided, the pop-out icon isn’t removed, but it’s disabled.
disabledText	string	Hover text for the pop-out and pop-in icons if `disabled` is set to true. Optional.

Name

Type

Description

utilityId

string

The ID of the utility to disable pop-out for. Optional when called within a utility.

disabled

boolean

If true, disables pop-out and removes the pop-out icon for a utility that isn’t popped out. If the utility is already popped out, the pop-out icon is disabled.

If disabledText is provided, the pop-out icon isn’t removed, but it’s disabled.

disabledText

string

Hover text for the pop-out and pop-in icons if disabled is set to true. Optional.

Aura Components Sample Code

This component has a button that, when pressed, disables utility pop-out.

Component code:

Controller code:

Response

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

Salesforce Console Developer Guide

disableUtilityPopOut() for Lightning Experience

Arguments

Aura Components Sample Code

Response