Note: 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.

minimizeUtility() for Lightning Experience

Minimizes a utility. This method isn’t supported for Lightning Web Components (LWC).

For LWC usage, see minimize().

Arguments

Name Type Description
utilityId string The ID of the utility to minimize. Optional when called within a utility.

Aura Components Sample Code

This component minimizes the utility when the button is pressed.

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:utilityBarAPI aura:id="utilitybar" />
3    <lightning:button label="Minimize Utility" onclick="{! c.handleMinimizeUtility }" />
4</aura:component>

Controller code:

1({
2    handleMinimizeUtility : function(component, event, helper) {
3        var utilityAPI = component.find("utilitybar");
4        utilityAPI.minimizeUtility();
5    }
6})

Response

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