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 and the GM - Data Import Monitor to an Experience Cloud site that hosts GridMate grids.
Specification
Utility Bar JSON Config
String
JSON array of utility items. Each item supports the following keys:
name: Unique name of the item.
label: Label of the item button.
iconName: Icon of the item button. All lightning icons are supported.
component: The component to display, as
namespace/componentName. Ex.gmpkg/bulkActionMonitorLWC.attributes: JSON object of the component properties. Ex.
{"cleanupDelay": 30}.width: Panel width, in px or any CSS unit. The default value is 400px.
height: Panel height, in px or any CSS unit. The default value is 450px.
startAutomatically: Set to true to create the component at page load instead of the first time the item is opened.
An item without label and iconName is headless: no button is displayed. Combined with startAutomatically, it is useful to run a background component.
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:
[
{
"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
}
]API Reference
Last updated
Was this helpful?