Platform Utility Bar API

lightning/platformUtilityBarApi

Work with a utility within the utility bar of a Lightning app using the lightning/platformUtilityBarApi module. The utility bar is a footer that gives users quick access to frequently used tools and components. Each utility is a single-column Lightning page that includes a standard or custom Lightning component. The lightning/platformUtilityBarApi module requires API version 61.0 or later.

For Use In

Lightning Experience

The lightning/platformUtilityBarApi module provides LWC Utility Bar API methods to control a utility within the utility bar of a Lightning app. All the methods in the lightning/platformUtilityBarApi module return a Promise. Required method parameters are explicitly passed as individual arguments. Optional parameters are passed into an object as the last argument of the method.

To use the Utility Bar API in your component, import the functions in your component's JavaScript file.

The following example minimizes an open utility panel.

For this module's documentation, see Methods for the Utility Bar in Lightning Experience in the Console Developer Guide.