EnclosingUtilityId Context Wire Adapter for Lightning Experience

To obtain the ID of the enclosing utility, use this context wire adapter. If a caller component isn’t using the wire adapter inside a panel, the enclosing utility ID is null.

LWC Sample Code

Before you can use the LWC utility bar API, Lightning Web Security must be enabled.

This component minimizes a utility bar panel using the enclosing utility ID and the minimize() method.

1import { LightningElement, wire } from 'lwc';
2import { EnclosingUtilityId, minimizeUtility } from 'lightning/platformUtilityBarApi';
3
4export default class MinimizeUtilityExample extends LightningElement {
5  @wire(EnclosingUtilityId) utilityId;
6
7  handleClick() {
8    if (!this.utilityId) {
9      return;
10    }
11    // Minimize the utility bar panel
12    minimize(this.utilityId);
13  }
14}

To make your component available for use in a utility bar, specify the lightning__UtilityBar target in the component’s configuration file.

Response

Returns the enclosing utility ID if the caller component is within a utility,  or null otherwise.