---
schema_version: "1"
id: f88ba1dbaa554de104a24377d4aa2c0536c94a114e54b0ca37cf744c514fc06d
title: Platform Utility Bar API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/lightning-base-components/lightning-design-system/guides/lwc/components/lightning/platformUtilityBarApi/lightning-platform-utility-bar-api.md
canonical_url: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-platform-utility-bar-api.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: b2edc8bd3cb1c145c300699d40f73709602da0edc12aab2dcf771bd78328b45a
products:
  - Lightning Component Reference
---
# 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

::::::tabset{tabs='[ "Develop", "Specifications" ]'}

:::::tab
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.

```javascript
import {
  enableModal,
  enablePopout,
  getAllUtilityInfo,
  getUtilityInfo,
  minimize,
  onUtilityClick,
  open,
  updatePanel,
  updateUtility,
} from "lightning/platformUtilityBarApi";
```

The following example minimizes an open utility panel.

```javascript
// c/myComponent.js
import { LightningElement, wire } from "lwc";
import { EnclosingUtilityId, minimize } from "lightning/platformUtilityBarApi";

export default class MyComponent extends LightningElement {
  @wire(EnclosingUtilityId) utilityId;

  onMinimize(event) {
    if (!this.utilityId) {
      return;
    }
    minimize(this.utilityId).then((isMinimized) => {
      console.log(`Minimize utilty ${isMinimized ? "successfully" : "failed"}`);
    });
  }
}
```

For this module's documentation, see [Methods for the Utility Bar in Lightning Experience](https://developer.salesforce.com/docs/atlas.en-us.api_console.meta/api_console/sforce_api_console_methods_lightning_utilityBarAPI.htm) in the Console Developer Guide.

:::::

:::::tab
::component-specification{component="platformUtilityBarApi" model="lwc" namespace="lightning"}

:::::

::::::