setUtilityLabel() for Lightning Experience

Sets the label of a utility. This text is displayed in the utility bar. This method isn’t supported for Lightning Web Components (LWC).

For LWC usage, see updateUtility() for Lightning Experience.

Arguments

Name	Type	Description
utilityId	string	The ID of the utility of which to set the label. Optional when called within a utility.
label	string	The label of the utility displayed in the utility bar.

Aura Components Sample Code

This component, when added to a single-column Lightning page used in a utility bar, sets the label of the utility to “My Favorite 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="Set Utility Label" onclick="{! c.handleSetUtilityLabel }" />
4</aura:component>

Controller code:

1({
2    handleSetUtilityLabel : function(component, event, helper) {
3        var utilityAPI = component.find("utilitybar");
4        utilityAPI.setUtilityLabel({
5            label: "My Favorite Utility"
6        });
7    }
8})

Response

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

Salesforce Console Developer Guide

setUtilityLabel() for Lightning Experience

Arguments

Aura Components Sample Code

Response