setUtilityHighlighted() for Lightning Experience

Sets a utility as highlighted, giving it a badge and a more prominent background color. This method isn’t supported for Lightning Web Components (LWC).

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

NameTypeDescription
utilityIdstringThe ID of the utility to highlight. Optional when called within a utility.
highlightedbooleanWhether the utility is highlighted. Makes a utility more prominent by giving it a different background color.

This component, when added to a single-column Lightning page used in a utility bar, sets a utility as highlighted when the button is pressed.

Component code:

Controller code:

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