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:

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

Controller code:

({
    handleMinimizeUtility : function(component, event, helper) {
        var utilityAPI = component.find("utilitybar");
        utilityAPI.minimizeUtility();
    }
})

Response

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