@genesislcap/grid-pro 15.71.0 → 15.72.0-FUI-2629.7

package/dist/grid-pro.api.json

@@ -760,7 +760,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!ActionsMenuRenderer#refresh:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Hands the latest row data to the menu, so per-row actions and disabled states stay current.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -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",
@@ -14322,7 +14373,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/grid-pro!getActionsMenuDef:function(1)",
-          "docComment": "/**\n * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).\n *\n * @param actions - Array of `ActionMenuItem` to be displayed in the menu.\n *\n * @param overrideDef - Optional override for the ColDef. Will override any of the default values. Default is an empty object.\n *\n * @param customActionsOpenerName - Optional custom name for the button that opens the menu. Default is '⋮'.\n *\n * @param isVertical - Optional flag to display the menu vertically. Default is false (displays the menu horizontally, follow the rowHeight).\n *\n * @param buttonAppearance - Optional appearance for the button that opens the menu. Default is 'outline'.\n *\n * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for Actions Menu Renderer.\n *\n * @example\n * ```ts\n * public exampleActionsMenuDef: ColDef = getActionsMenuDef(\n *  [\n *    {\n *      name: 'View',\n *      callback: (rowData) => logger.debug('VIEWW!!!', rowData),\n *    },\n *      {\n *      name: 'Delete',\n *      callback: (rowData) => logger.debug('DELETE!!!', rowData),\n *    },\n *  ],\n *  {\n *    headerName: 'Instrument Actions',\n *    width: 180,\n *  },\n *  '+',\n *  true,\n *  'primary-gradient'\n * );\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).\n *\n * @param actions - Array of `ActionMenuItem` to be displayed in the menu, or a function of the row data returning that array (for row-scoped eligibility/permission filtering).\n *\n * @param overrideDef - Optional override for the ColDef. Will override any of the default values. Default is an empty object.\n *\n * @param customActionsOpenerName - Optional custom name for the button that opens the menu. Default is '⋮'.\n *\n * @param isVertical - Optional flag to display the menu vertically. Default is false (displays the menu horizontally, follow the rowHeight).\n *\n * @param buttonAppearance - Optional appearance for the button that opens the menu. Default is 'outline'.\n *\n * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for Actions Menu Renderer.\n *\n * @example\n * ```ts\n * public exampleActionsMenuDef: ColDef = getActionsMenuDef(\n *  [\n *    {\n *      name: 'View',\n *      callback: (rowData) => logger.debug('VIEWW!!!', rowData),\n *    },\n *      {\n *      name: 'Delete',\n *      callback: (rowData) => logger.debug('DELETE!!!', rowData),\n *    },\n *  ],\n *  {\n *    headerName: 'Instrument Actions',\n *    width: 180,\n *  },\n *  '+',\n *  true,\n *  'primary-gradient'\n * );\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -14330,12 +14381,8 @@
             },
             {
               "kind": "Reference",
-              "text": "ActionMenuItem",
-              "canonicalReference": "@genesislcap/foundation-ui!ActionMenuItem:type"
-            },
-            {
-              "kind": "Content",
-              "text": "[]"
+              "text": "ActionMenuItems",
+              "canonicalReference": "@genesislcap/foundation-ui!ActionMenuItems:type"
             },
             {
               "kind": "Content",
@@ -14382,8 +14429,8 @@
           ],
           "fileUrlPath": "src/cell-renderers/actions-menu.renderer.ts",
           "returnTypeTokenRange": {
-            "startIndex": 12,
-            "endIndex": 13
+            "startIndex": 11,
+            "endIndex": 12
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -14392,39 +14439,39 @@
               "parameterName": "actions",
               "parameterTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 3
+                "endIndex": 2
               },
               "isOptional": false
             },
             {
               "parameterName": "overrideDef",
               "parameterTypeTokenRange": {
-                "startIndex": 4,
-                "endIndex": 5
+                "startIndex": 3,
+                "endIndex": 4
               },
               "isOptional": true
             },
             {
               "parameterName": "customActionsOpenerName",
               "parameterTypeTokenRange": {
-                "startIndex": 6,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 6
               },
               "isOptional": true
             },
             {
               "parameterName": "isVertical",
               "parameterTypeTokenRange": {
-                "startIndex": 8,
-                "endIndex": 9
+                "startIndex": 7,
+                "endIndex": 8
               },
               "isOptional": true
             },
             {
               "parameterName": "buttonAppearance",
               "parameterTypeTokenRange": {
-                "startIndex": 10,
-                "endIndex": 11
+                "startIndex": 9,
+                "endIndex": 10
               },
               "isOptional": true
             }
@@ -15678,6 +15725,122 @@
           ],
           "name": "getTextRendererTemplate"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!getVerticalDropdownMenuDef:function(1)",
+          "docComment": "/**\n * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for a vertical Actions Menu behind an icon-only \"kebab\" opener, for a pinned column of per-row actions. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).\n *\n * @remarks\n *\n * The opener hides itself on rows with no actions, so it never opens an empty menu. The column has a `colId` but no `field`: AG Grid only refreshes a cell with a field when its value changes, and this column has no value, so a row update would leave stale actions. Having no value, the column is also not sortable, filterable, resizable or flashed, and shows no header menu button — pass any of these in `overrideDef` to turn them back on.\n *\n * @param actions - Array of `ActionMenuItem` to be displayed in the menu, or a function of the row data returning that array (for row-scoped eligibility/permission filtering).\n *\n * @param overrideDef - Optional override for the ColDef. Will override any of the default values. Default is an empty object.\n *\n * @param iconName - Optional icon name for the opener. Default is `'ellipsis'` (horizontal dots); pass `'ellipsis-vertical'` for vertical ones.\n *\n * @param buttonAppearance - Optional appearance for the button that opens the menu.\n *\n * @param hideDisabled - Optional flag to hide disabled actions instead of greying them out. Default is false. When every action for a row is hidden, the opener hides too.\n *\n * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for Actions Menu Renderer.\n *\n * @example\n * ```ts\n * public exampleMoreColumnDef: ColDef = getVerticalDropdownMenuDef(\n *   (rowData) => [\n *     { name: 'Ping Trader', icon: { name: 'paper-plane' }, callback: (rowData) => pingTrader(rowData) },\n *     { name: 'Assign', icon: { name: 'user' }, callback: (rowData) => assign(rowData) },\n *   ],\n *   { headerName: '', pinned: 'right' },\n * );\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "getVerticalDropdownMenuDef: (actions: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ActionMenuItems",
+              "canonicalReference": "@genesislcap/foundation-ui!ActionMenuItems:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", overrideDef?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColDef",
+              "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    suppressHeaderMenuButton?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ", iconName?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", buttonAppearance?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", hideDisabled?: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "ColDef",
+              "canonicalReference": "@ag-grid-community/core!ColDef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " & {\n    suppressHeaderMenuButton?: boolean;\n}"
+            }
+          ],
+          "fileUrlPath": "src/cell-renderers/actions-menu.renderer.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 12,
+            "endIndex": 14
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "actions",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "overrideDef",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "iconName",
+              "parameterTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "buttonAppearance",
+              "parameterTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "hideDisabled",
+              "parameterTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 11
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "getVerticalDropdownMenuDef"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!GRID_PRO_COLUMN_DRAG_BRIDGE_CONTEXT_KEY:var",
@@ -16405,6 +16568,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 +17990,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<any, any>) => void) | ((event: import(\"ag-grid-community\")."
+                  "text": "<any, any>) => void) | ((event: "
                 },
                 {
                   "kind": "Reference",
@@ -21231,6 +21456,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",