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.