> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/package-reference/components-library/utilities-and-monitoring/gm-utility-bar.md).

# GM - Utility Bar

(gmpkg:utilityBarComponent)

## **Documentation**

**GM - Utility Bar** component adds a utility bar to an Experience Cloud site, where the standard Lightning utility bar is not available. The bar is docked at the bottom of the page and displays one button per item; clicking a button opens the item in a flyout panel. When the items don't fit in the bar, the extra items are moved to a **More** menu. A component is created the first time its item is opened (or at page load when `startAutomatically` is set) and is kept alive when the panel is minimized.

The component comes in two versions, both available in Experience Builder:

* **GM - Utility Bar (Aura)** (`gmpkg:utilityBarComponent`), available for all page types.
* **GM - Utility Bar (LWC)** (`gmpkg:utilityBarLWC`), available on site pages and in the theme layout.

**Use case:** Add the [GM - Bulk Action Monitor](https://docs.gridmate.io/package-reference/components-library/utilities-and-monitoring/gm-bulk-action-monitor.md) and the [GM - Data Import Monitor](https://docs.gridmate.io/package-reference/components-library/utilities-and-monitoring/gm-data-import-monitor.md) to an Experience Cloud site that hosts GridMate grids.

## **Specification**

<table data-full-width="true"><thead><tr><th width="211.3741455078125">Property</th><th width="131.33333333333331">Type</th><th width="504.45829264322924">Description</th></tr></thead><tbody><tr><td>Utility Bar JSON Config</td><td>String</td><td><p>JSON array of utility items. Each item supports the following keys:</p><ul><li><strong>name:</strong> Unique name of the item.</li><li><strong>label:</strong> Label of the item button.</li><li><strong>iconName:</strong> Icon of the item button. All lightning icons are supported.</li><li><strong>component:</strong> The component to display, as <code>namespace/componentName</code>. Ex. <code>gmpkg/bulkActionMonitorLWC</code>.</li><li><strong>attributes:</strong> JSON object of the component properties. Ex. <code>{"cleanupDelay": 30}</code>.</li><li><strong>width:</strong> Panel width, in px or any CSS unit. The default value is 400px.</li><li><strong>height:</strong> Panel height, in px or any CSS unit. The default value is 450px.</li><li><strong>startAutomatically:</strong> Set to true to create the component at page load instead of the first time the item is opened.</li></ul><p>An item without <strong>label</strong> and <strong>iconName</strong> is headless: no button is displayed. Combined with <strong>startAutomatically</strong>, it is useful to run a background component.</p></td></tr></tbody></table>

Below is an example with the Bulk Action Monitor and the Data Import Monitor. The monitors use `startAutomatically` so they track the jobs started before their panel is opened:

```json
[
    {
        "name": "bulkActionMonitor",
        "label": "Bulk Actions",
        "iconName": "utility:multi_select_checkbox",
        "component": "gmpkg/bulkActionMonitorLWC",
        "attributes": { "cleanupDelay": 30 },
        "width": 400,
        "height": 450,
        "startAutomatically": true
    },
    {
        "name": "dataImportMonitor",
        "label": "Data Imports",
        "iconName": "utility:upload",
        "component": "gmpkg/dataImportMonitorLWC",
        "startAutomatically": true
    }
]
```

{% hint style="info" %}
With **GM - Utility Bar (LWC)**, the GridMate monitors are referenced as `c/bulkActionMonitorLWC`, `c/dataImportMonitorLWC` and `c/interactionMonitorLWC`. Any other component is loaded dynamically from the **component** value.
{% endhint %}

## **API Reference**

{% tabs fullWidth="true" %}
{% tab title="utilityBarComponent.design" %}

```xml
<design:component label="GM - Utility Bar (Aura)">
    <design:attribute
        name="jsonConfigString"
        label="Utility Bar JSON Config"
        description="Stringified JSON array containing core package dashboard metadata variables mappings parameters configurations rules."
    />
</design:component>
```

{% endtab %}

{% tab title="utilityBarLWC.js-meta.xml" %}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>65.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - Utility Bar (LWC)</masterLabel>
    <description>Custom utility bar with Dynamic Component capabilities.</description>
    <targets>
        <target>lightningCommunity__Page</target>
        <target>lightningCommunity__Default</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightningCommunity__Default">
            <property
                name="jsonConfigString"
                type="String"
                label="Utility Bar JSON Config"
                description="Stringified JSON array of utility item configurations."
            />
        </targetConfig>
    </targetConfigs>
    <capabilities>
        <capability>lightning__dynamicComponent</capability>
    </capabilities>
</LightningComponentBundle>
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gridmate.io/package-reference/components-library/utilities-and-monitoring/gm-utility-bar.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
