1

I'm creating a Utility Bar component using Aura. There does not appear to be a way for me to set the default "Label" or "Icon" for the component when showing on the "Custom" Utility List. It shows the actual Component Name.

For example: Component name is "AgentQuestionsUtilityBar" (which is the aura wrapper for my utility bar component). It shows as "AgentQuestionsUtilityBar" on the custom item list when I add it to the Utility Bar. Once added, I can manually change the label and icon... but I would love to have it set by default.

It appears that the LWC can do this, as it uses "MasterLabel" in the metadata to show the label on the custom component listing. Is there no way to do this for Aura Components? (in the screenshot, you can see the LWC labeled as "Agent Questions" even though in code its name is agentQuestions)

Screenshot of Add Utility Item picklist

1 Answer 1

3

You'd do this through the Aura Component Bundle Design Resource. Specifically, the label attribute:

Sets the label of the component when it displays in tools such as App Builder.

When creating a custom Lightning page template component, this text displays as the name of the template in the Lightning App Builder new page wizard.

If you add this .design file to your aura bundle, it can just be the label if you have no other attributes to define.

<design:component label="Kris Test">

</design:component>

The above looks like the following in the Add Utility Item UI

enter image description here

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .