@genesislcap/grid-pro 15.71.1-alpha-71cb16e4d3.0 → 15.73.0

package/dist/esm/grid-pro.js

@@ -13,6 +13,7 @@ import { GridProColumn, resolveVisibleColumnFields } from './column';
 import { EnumColumnFilter, EnumColumnFloatingFilter, GridProFilterTypes } from './column-filters';
 import { ColumnSelection, gridProColumnSelectionHostStyles } from './column-selection';
 import { GRID_PRO_COLUMN_DRAG_BRIDGE_CONTEXT_KEY, gridProColumnDragBridgeModule, } from './column-selection/grid-pro-column-drag-bridge';
+import { openGridContextMenu } from './context-menu/context-menu';
 import { GridProClientSideDatasource, GridProInfiniteDatasource, GridProServerSideDatasource, } from './datasource';
 import { baseDatasourceEventNames } from './datasource/base.types';
 import { errorHandlerDialogStyles } from './datasource/error-handler.dialog';
@@ -159,6 +160,9 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         }
         return undefined;
     }
+    contextMenuItemsChanged() {
+        this.syncContextMenuSuppression();
+    }
     enableColumnSelectionChanged() {
         this.syncColumnSelectionHostLayout();
     }
@@ -234,6 +238,8 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         this.statusPanelState = {};
         this.warnedUnregisteredStatusBar = false;
         this.warnedGridOptionsStatusBar = false;
+        /** Whether the AG grid instance was created with its own context menu suppressed. */
+        this.gridCreatedWithMenuSuppressed = false;
         /**
          * Shows a Columns side panel on the trailing edge of the grid.
          * @public
@@ -247,6 +253,15 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         this.registeredGridEvents = new Set();
         this.gridEventListeners = new Map();
         this.boundGlobalEventListener = this.globalEventListener.bind(this);
+        /**
+         * `globalListener` runs on a timeout, which is too late to cancel the browser menu.
+         * This one runs inside the right-click event.
+         */
+        this.boundContextMenuListener = (eventType, event) => {
+            if (eventType === 'cellContextMenu') {
+                this.showContextMenu(event);
+            }
+        };
         this._filterConfig = undefined;
         this.handleLuminanceChange = (record) => {
             const luminance = baseLayerLuminance.getValueFor(record.target);
@@ -414,11 +429,13 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         this.toggleDatasourceEventListeners(true);
     }
     disconnectedCallback() {
-        var _a;
+        var _a, _b;
+        (_a = this.closeContextMenu) === null || _a === void 0 ? void 0 : _a.call(this);
+        this.closeContextMenu = undefined;
         this.disposed = true;
         this.debouncedSaveColumnState.cancel();
         this.debouncedSaveFilterModel.cancel();
-        const luminanceTarget = (_a = this.provider) !== null && _a !== void 0 ? _a : this;
+        const luminanceTarget = (_b = this.provider) !== null && _b !== void 0 ? _b : this;
         baseLayerLuminance.unsubscribe(this.luminanceObserver, luminanceTarget);
         if (this.luminanceSubscription) {
             this.luminanceSubscription.unsubscribe();
@@ -1171,6 +1188,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
     get gridParams() {
         return {
             globalListener: this.boundGlobalEventListener,
+            globalSyncListener: this.boundContextMenuListener,
             modules: [gridProColumnDragBridgeModule, ColumnMoveModule, DragAndDropModule],
         };
     }
@@ -1238,6 +1256,9 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         const derivedOptions = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this.gridOptionsConfig), { defaultColDef: Object.assign({ enableCellChangeFlash: this.enableCellFlashing, filter: true, resizable: true, sortable: true }, defaultColDef), components: this.combineAllGridComponents(components), headerHeight: this.headerHeight, rowHeight: this.rowHeight, animateRows: false, suppressDragLeaveHidesColumns: true }), this.eventsAndCallbacks), { onGridReady: (event) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
                 this.gridApi = event.api;
+                if (!!this.contextMenuItems !== this.gridCreatedWithMenuSuppressed) {
+                    this.syncContextMenuSuppression();
+                }
                 this.applyStatusBarMode();
                 if (this.gridEventsQueue.length) {
                     this.gridEventsQueue.forEach((type) => {
@@ -1374,7 +1395,9 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
                     this.gridSlot.removeChild(this.gridSlot.firstChild);
                 }
             }
-            this.agGrid = createGrid(this.gridSlot, this.agGridOptions, this.gridParams);
+            this.gridCreatedWithMenuSuppressed = !!this.contextMenuItems;
+            this.agGrid = createGrid(this.gridSlot, this.gridCreatedWithMenuSuppressed
+                ? Object.assign(Object.assign({}, this.agGridOptions), { suppressContextMenu: true }) : this.agGridOptions, this.gridParams);
             this.initialised = true;
         });
     }
@@ -1508,9 +1531,61 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             if (this.initialised) {
                 // for subsequent (post gridOptions) changes - use setGridOption API for v35
                 (_a = this.gridApi) === null || _a === void 0 ? void 0 : _a.setGridOption(gridPropertyName, newValue);
+                if (gridPropertyName === 'suppressContextMenu' && this.contextMenuItems) {
+                    this.syncContextMenuSuppression();
+                }
             }
         }
     }
+    /**
+     * AG Grid draws its own menu when `ContextMenu` is registered, so it is suppressed while
+     * `contextMenuItems` is set and the app's own `suppressContextMenu` restored when it is cleared.
+     * The suppression goes to AG Grid only, never into `agGridOptions`: that object is what the
+     * `gridOptions` getter returns, and an app re-applying it would otherwise adopt the setting.
+     * @internal
+     */
+    syncContextMenuSuppression() {
+        var _a, _b, _c, _d;
+        const appSetting = (_c = (_a = this.agAttributes.suppressContextMenu) !== null && _a !== void 0 ? _a : (_b = this.agGridOptions) === null || _b === void 0 ? void 0 : _b.suppressContextMenu) !== null && _c !== void 0 ? _c : false;
+        (_d = this.gridApi) === null || _d === void 0 ? void 0 : _d.setGridOption('suppressContextMenu', this.contextMenuItems ? true : appSetting);
+    }
+    /**
+     * Opens the grid's right-click menu for a cell. Called from the synchronous grid listener so
+     * `preventDefault` still cancels the browser menu.
+     * @internal
+     */
+    showContextMenu(event) {
+        var _a, _b, _c, _d, _e;
+        const items = (_a = this.contextMenuItems) === null || _a === void 0 ? void 0 : _a.call(this, event);
+        if (!(items === null || items === void 0 ? void 0 : items.length)) {
+            return;
+        }
+        const mouse = event.event instanceof MouseEvent ? event.event : null;
+        const pathTarget = mouse === null || mouse === void 0 ? void 0 : mouse.composedPath()[0];
+        const target = pathTarget instanceof Element ? pathTarget : null;
+        let x = (_b = mouse === null || mouse === void 0 ? void 0 : mouse.clientX) !== null && _b !== void 0 ? _b : 0;
+        let y = (_c = mouse === null || mouse === void 0 ? void 0 : mouse.clientY) !== null && _c !== void 0 ? _c : 0;
+        // A menu opened from the keyboard can arrive without a pointer position.
+        const cell = target === null || target === void 0 ? void 0 : target.closest('.ag-cell');
+        if (x === 0 && y === 0 && cell) {
+            const rect = cell.getBoundingClientRect();
+            x = rect.left;
+            y = rect.bottom;
+        }
+        (_d = this.closeContextMenu) === null || _d === void 0 ? void 0 : _d.call(this);
+        const [prefix = 'foundation'] = this.tagName.toLowerCase().split('-');
+        this.closeContextMenu = openGridContextMenu({
+            prefix,
+            x,
+            y,
+            items,
+            container: (_e = this.shadowRoot) !== null && _e !== void 0 ? _e : undefined,
+            themeSource: target,
+        });
+        if (this.closeContextMenu && (mouse === null || mouse === void 0 ? void 0 : mouse.cancelable)) {
+            mouse.preventDefault();
+        }
+    }
     globalEventListener(eventType, event) {
         const eventLowerCase = eventType.toLowerCase();
         const browserEvent = new Event(eventLowerCase);
@@ -1597,6 +1672,9 @@ __decorate([
 __decorate([
     observable
 ], GridPro.prototype, "statusBarMode", void 0);
+__decorate([
+    observable
+], GridPro.prototype, "contextMenuItems", void 0);
 __decorate([
     attr({ mode: 'boolean', attribute: 'enable-column-selection' })
 ], GridPro.prototype, "enableColumnSelection", void 0);

package/dist/esm/index.js

@@ -4,6 +4,7 @@ export * from './cell-editors';
 export * from './column';
 export * from './column-selection';
 export * from './column-filters';
+export * from './context-menu';
 export * from './datasource';
 export * from './external';
 export * from './grid-components';

package/dist/grid-pro.api.json

@@ -7315,6 +7315,57 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!defaultGridContextMenuItems:function(1)",
+          "docComment": "/**\n * A CSV Export item, using AG Grid's community CSV export. Assign it to `contextMenuItems` as the whole menu, or spread its result into a menu of your own. Empty when the grid sets `suppressCsvExport`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function defaultGridContextMenuItems(event: "
+            },
+            {
+              "kind": "Reference",
+              "text": "CellContextMenuEvent",
+              "canonicalReference": "ag-grid-community!CellContextMenuEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProContextMenuItem",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/context-menu/context-menu.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "event",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "defaultGridContextMenuItems"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!defaultGridOptionsConfig:var",
@@ -16405,6 +16456,68 @@
               "isAbstract": false,
               "name": "connectedCallback"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#contextMenuItems:member",
+              "docComment": "/**\n * Opts the grid into its own right-click menu, built from these items for each cell. It needs no AG Grid Enterprise module, and replaces AG Grid's context menu while set. Assign {@link defaultGridContextMenuItems} for a CSV Export menu, or return an empty list to show the browser's menu for that cell.\n *\n * Unset, right-click is left alone: AG Grid's menu when its `ContextMenu` module is registered, otherwise the browser's.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "contextMenuItems?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GridProContextMenuItems",
+                  "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItems:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "contextMenuItems",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridPro#contextMenuItemsChanged:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "contextMenuItemsChanged(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "contextMenuItemsChanged"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GridPro#customErrorHandlerTemplate:member",
@@ -17765,7 +17878,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<any, any>) => void) | ((event: import(\"ag-grid-community\")."
+                  "text": "<any, any>) => void) | ((event: "
                 },
                 {
                   "kind": "Reference",
@@ -21231,6 +21344,293 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuEntry:type",
+          "docComment": "/**\n * An item, or `'separator'` for a dividing line between groups of items.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProContextMenuEntry = "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProContextMenuItem",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | 'separator'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/context-menu/context-menu.ts",
+          "releaseTag": "Public",
+          "name": "GridProContextMenuEntry",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem:interface",
+          "docComment": "/**\n * One entry in grid-pro's right-click menu.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface GridProContextMenuItem "
+            }
+          ],
+          "fileUrlPath": "src/context-menu/context-menu.ts",
+          "releaseTag": "Public",
+          "name": "GridProContextMenuItem",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#action:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "action?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "action",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#checked:member",
+              "docComment": "/**\n * Set to `true` or `false` to make the item a checkbox; leave unset for a plain item.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "checked?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "checked",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#disabled:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disabled?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "disabled",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#name:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#shortcut:member",
+              "docComment": "/**\n * Drawn to the right of the name, for example a key combination.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "shortcut?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "shortcut",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#subMenu:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "subMenu?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GridProContextMenuEntry",
+                  "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuEntry:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "subMenu",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItem#tooltip:member",
+              "docComment": "/**\n * Shown on hover, including while the item is disabled — say why it cannot be chosen.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tooltip?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "tooltip",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuItems:type",
+          "docComment": "/**\n * Builds the right-click menu for one cell. Return an empty list to show the browser's menu.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GridProContextMenuItems = "
+            },
+            {
+              "kind": "Content",
+              "text": "(event: "
+            },
+            {
+              "kind": "Reference",
+              "text": "CellContextMenuEvent",
+              "canonicalReference": "ag-grid-community!CellContextMenuEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProContextMenuEntry",
+              "canonicalReference": "@genesislcap/grid-pro!GridProContextMenuEntry:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/context-menu/context-menu.ts",
+          "releaseTag": "Public",
+          "name": "GridProContextMenuItems",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/grid-pro!GridProErrorEvent:type",