@genesislcap/grid-pro 15.42.0 → 15.43.0-FUI-2629.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,7 +9,7 @@ import * as changeCase from 'change-case';
9
9
  import debounce from 'lodash.debounce';
10
10
  import { GridProCell } from './cell';
11
11
  import { DateEditor, MultiselectEditor, NumberEditor, SelectEditor, StringEditor, } from './cell-editors';
12
- import { ActionRenderer, ActionsMenuRenderer, BooleanRenderer, EditableRenderer, IconRenderer, SelectRenderer, StatusPillRenderer, } from './cell-renderers';
12
+ import { ActionRenderer, ActionsMenuRenderer, VerticalDropdownMenuRenderer, BooleanRenderer, EditableRenderer, IconRenderer, SelectRenderer, StatusPillRenderer, } from './cell-renderers';
13
13
  import { GridProColumn, resolveVisibleColumnFields } from './column';
14
14
  import { EnumColumnFilter, EnumColumnFloatingFilter, GridProFilterTypes } from './column-filters';
15
15
  import { ColumnSelection, gridProColumnSelectionHostStyles } from './column-selection';
@@ -795,6 +795,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
795
795
  const defaultFoundationAgComponents = {
796
796
  [GridProRendererTypes.action]: ActionRenderer,
797
797
  [GridProRendererTypes.actionsMenu]: ActionsMenuRenderer,
798
+ [GridProRendererTypes.verticalDropdownMenu]: VerticalDropdownMenuRenderer,
798
799
  [GridProRendererTypes.boolean]: BooleanRenderer,
799
800
  [GridProRendererTypes.editable]: EditableRenderer,
800
801
  [GridProRendererTypes.icon]: IconRenderer,
@@ -125,6 +125,7 @@ export var GridProRendererTypes;
125
125
  (function (GridProRendererTypes) {
126
126
  GridProRendererTypes["action"] = "action";
127
127
  GridProRendererTypes["actionsMenu"] = "actionsMenu";
128
+ GridProRendererTypes["verticalDropdownMenu"] = "verticalDropdownMenu";
128
129
  GridProRendererTypes["boolean"] = "boolean";
129
130
  GridProRendererTypes["editable"] = "editable";
130
131
  GridProRendererTypes["icon"] = "icon";
@@ -10233,6 +10233,51 @@
10233
10233
  "text": "ActionsMenuRenderer",
10234
10234
  "canonicalReference": "@genesislcap/grid-pro!ActionsMenuRenderer:class"
10235
10235
  },
10236
+ {
10237
+ "kind": "Content",
10238
+ "text": ">;\n foundationGridProVerticalDropdownMenuRenderer: (overrideDefinition?: import(\"@microsoft/fast-foundation\")."
10239
+ },
10240
+ {
10241
+ "kind": "Reference",
10242
+ "text": "OverrideFoundationElementDefinition",
10243
+ "canonicalReference": "@microsoft/fast-foundation!OverrideFoundationElementDefinition:type"
10244
+ },
10245
+ {
10246
+ "kind": "Content",
10247
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
10248
+ },
10249
+ {
10250
+ "kind": "Reference",
10251
+ "text": "ViewTemplate",
10252
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
10253
+ },
10254
+ {
10255
+ "kind": "Content",
10256
+ "text": "<any, any>;\n }>) => import(\"@microsoft/fast-foundation\")."
10257
+ },
10258
+ {
10259
+ "kind": "Reference",
10260
+ "text": "FoundationElementRegistry",
10261
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElementRegistry:class"
10262
+ },
10263
+ {
10264
+ "kind": "Content",
10265
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
10266
+ },
10267
+ {
10268
+ "kind": "Reference",
10269
+ "text": "ViewTemplate",
10270
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
10271
+ },
10272
+ {
10273
+ "kind": "Content",
10274
+ "text": "<any, any>;\n }, typeof import(\"./cell-renderers\")."
10275
+ },
10276
+ {
10277
+ "kind": "Reference",
10278
+ "text": "VerticalDropdownMenuRenderer",
10279
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer:class"
10280
+ },
10236
10281
  {
10237
10282
  "kind": "Content",
10238
10283
  "text": ">;\n foundationAgBooleanRenderer: (overrideDefinition?: import(\"@microsoft/fast-foundation\")."
@@ -11342,7 +11387,7 @@
11342
11387
  "name": "foundationGridComponents",
11343
11388
  "variableTypeTokenRange": {
11344
11389
  "startIndex": 1,
11345
- "endIndex": 292
11390
+ "endIndex": 302
11346
11391
  }
11347
11392
  },
11348
11393
  {
@@ -11809,6 +11854,92 @@
11809
11854
  "endIndex": 2
11810
11855
  }
11811
11856
  },
11857
+ {
11858
+ "kind": "Function",
11859
+ "canonicalReference": "@genesislcap/grid-pro!foundationGridProVerticalDropdownMenuRenderer:function(1)",
11860
+ "docComment": "/**\n * A function that returns a Foundation Vertical Dropdown Menu for configuring the component with a DesignSystem.\n *\n * @remarks\n *\n * HTML Element: \\<foundation-grid-pro-vertical-dropdown-menu-renderer\\>\n *\n * @public\n */\n",
11861
+ "excerptTokens": [
11862
+ {
11863
+ "kind": "Content",
11864
+ "text": "foundationGridProVerticalDropdownMenuRenderer: (overrideDefinition?: "
11865
+ },
11866
+ {
11867
+ "kind": "Content",
11868
+ "text": "import(\"@microsoft/fast-foundation\")."
11869
+ },
11870
+ {
11871
+ "kind": "Reference",
11872
+ "text": "OverrideFoundationElementDefinition",
11873
+ "canonicalReference": "@microsoft/fast-foundation!OverrideFoundationElementDefinition:type"
11874
+ },
11875
+ {
11876
+ "kind": "Content",
11877
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
11878
+ },
11879
+ {
11880
+ "kind": "Reference",
11881
+ "text": "ViewTemplate",
11882
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
11883
+ },
11884
+ {
11885
+ "kind": "Content",
11886
+ "text": "<any, any>;\n}>"
11887
+ },
11888
+ {
11889
+ "kind": "Content",
11890
+ "text": ") => "
11891
+ },
11892
+ {
11893
+ "kind": "Content",
11894
+ "text": "import(\"@microsoft/fast-foundation\")."
11895
+ },
11896
+ {
11897
+ "kind": "Reference",
11898
+ "text": "FoundationElementRegistry",
11899
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElementRegistry:class"
11900
+ },
11901
+ {
11902
+ "kind": "Content",
11903
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
11904
+ },
11905
+ {
11906
+ "kind": "Reference",
11907
+ "text": "ViewTemplate",
11908
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
11909
+ },
11910
+ {
11911
+ "kind": "Content",
11912
+ "text": "<any, any>;\n}, typeof "
11913
+ },
11914
+ {
11915
+ "kind": "Reference",
11916
+ "text": "VerticalDropdownMenuRenderer",
11917
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer:class"
11918
+ },
11919
+ {
11920
+ "kind": "Content",
11921
+ "text": ">"
11922
+ }
11923
+ ],
11924
+ "fileUrlPath": "src/cell-renderers/vertical-dropdown-menu.renderer.ts",
11925
+ "returnTypeTokenRange": {
11926
+ "startIndex": 7,
11927
+ "endIndex": 14
11928
+ },
11929
+ "releaseTag": "Public",
11930
+ "overloadIndex": 1,
11931
+ "parameters": [
11932
+ {
11933
+ "parameterName": "overrideDefinition",
11934
+ "parameterTypeTokenRange": {
11935
+ "startIndex": 1,
11936
+ "endIndex": 6
11937
+ },
11938
+ "isOptional": true
11939
+ }
11940
+ ],
11941
+ "name": "foundationGridProVerticalDropdownMenuRenderer"
11942
+ },
11812
11943
  {
11813
11944
  "kind": "Function",
11814
11945
  "canonicalReference": "@genesislcap/grid-pro!foundationIconRenderer:function(1)",
@@ -15372,6 +15503,111 @@
15372
15503
  ],
15373
15504
  "name": "getTextRendererTemplate"
15374
15505
  },
15506
+ {
15507
+ "kind": "Function",
15508
+ "canonicalReference": "@genesislcap/grid-pro!getVerticalDropdownMenuDef:function(1)",
15509
+ "docComment": "/**\n * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for the Vertical Dropdown Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).\n *\n * @param items - Array of `VerticalDropdownMenuItem` 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-vertical'`.\n *\n * @param buttonAppearance - Optional appearance for the button that opens the menu.\n *\n * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for the Vertical Dropdown Menu Renderer.\n *\n * @example\n * ```ts\n * public exampleMoreColumnDef: ColDef = getVerticalDropdownMenuDef(\n * (rowData) => [\n * { label: 'Ping Trader', icon: { name: 'paper-plane' }, callback: (rowData) => pingTrader(rowData) },\n * { label: 'Assign', icon: { name: 'user' }, callback: (rowData) => assign(rowData) },\n * ],\n * { headerName: '', pinned: 'right' },\n * );\n * ```\n *\n * @public\n */\n",
15510
+ "excerptTokens": [
15511
+ {
15512
+ "kind": "Content",
15513
+ "text": "getVerticalDropdownMenuDef: (items: "
15514
+ },
15515
+ {
15516
+ "kind": "Reference",
15517
+ "text": "VerticalDropdownMenuItem",
15518
+ "canonicalReference": "@genesislcap/foundation-ui!VerticalDropdownMenuItem:type"
15519
+ },
15520
+ {
15521
+ "kind": "Content",
15522
+ "text": "[] | ((rowData: any) => "
15523
+ },
15524
+ {
15525
+ "kind": "Reference",
15526
+ "text": "VerticalDropdownMenuItem",
15527
+ "canonicalReference": "@genesislcap/foundation-ui!VerticalDropdownMenuItem:type"
15528
+ },
15529
+ {
15530
+ "kind": "Content",
15531
+ "text": "[])"
15532
+ },
15533
+ {
15534
+ "kind": "Content",
15535
+ "text": ", overrideDef?: "
15536
+ },
15537
+ {
15538
+ "kind": "Reference",
15539
+ "text": "ColDef",
15540
+ "canonicalReference": "@ag-grid-community/core!ColDef:interface"
15541
+ },
15542
+ {
15543
+ "kind": "Content",
15544
+ "text": ", iconName?: "
15545
+ },
15546
+ {
15547
+ "kind": "Content",
15548
+ "text": "string"
15549
+ },
15550
+ {
15551
+ "kind": "Content",
15552
+ "text": ", buttonAppearance?: "
15553
+ },
15554
+ {
15555
+ "kind": "Content",
15556
+ "text": "string"
15557
+ },
15558
+ {
15559
+ "kind": "Content",
15560
+ "text": ") => "
15561
+ },
15562
+ {
15563
+ "kind": "Reference",
15564
+ "text": "ColDef",
15565
+ "canonicalReference": "@ag-grid-community/core!ColDef:interface"
15566
+ }
15567
+ ],
15568
+ "fileUrlPath": "src/cell-renderers/vertical-dropdown-menu.renderer.ts",
15569
+ "returnTypeTokenRange": {
15570
+ "startIndex": 12,
15571
+ "endIndex": 13
15572
+ },
15573
+ "releaseTag": "Public",
15574
+ "overloadIndex": 1,
15575
+ "parameters": [
15576
+ {
15577
+ "parameterName": "items",
15578
+ "parameterTypeTokenRange": {
15579
+ "startIndex": 1,
15580
+ "endIndex": 5
15581
+ },
15582
+ "isOptional": false
15583
+ },
15584
+ {
15585
+ "parameterName": "overrideDef",
15586
+ "parameterTypeTokenRange": {
15587
+ "startIndex": 6,
15588
+ "endIndex": 7
15589
+ },
15590
+ "isOptional": true
15591
+ },
15592
+ {
15593
+ "parameterName": "iconName",
15594
+ "parameterTypeTokenRange": {
15595
+ "startIndex": 8,
15596
+ "endIndex": 9
15597
+ },
15598
+ "isOptional": true
15599
+ },
15600
+ {
15601
+ "parameterName": "buttonAppearance",
15602
+ "parameterTypeTokenRange": {
15603
+ "startIndex": 10,
15604
+ "endIndex": 11
15605
+ },
15606
+ "isOptional": true
15607
+ }
15608
+ ],
15609
+ "name": "getVerticalDropdownMenuDef"
15610
+ },
15375
15611
  {
15376
15612
  "kind": "Variable",
15377
15613
  "canonicalReference": "@genesislcap/grid-pro!GRID_PRO_COLUMN_DRAG_BRIDGE_CONTEXT_KEY:var",
@@ -25686,6 +25922,27 @@
25686
25922
  },
25687
25923
  "releaseTag": "Public",
25688
25924
  "name": "text"
25925
+ },
25926
+ {
25927
+ "kind": "EnumMember",
25928
+ "canonicalReference": "@genesislcap/grid-pro!GridProRendererTypes.verticalDropdownMenu:member",
25929
+ "docComment": "",
25930
+ "excerptTokens": [
25931
+ {
25932
+ "kind": "Content",
25933
+ "text": "verticalDropdownMenu = "
25934
+ },
25935
+ {
25936
+ "kind": "Content",
25937
+ "text": "\"verticalDropdownMenu\""
25938
+ }
25939
+ ],
25940
+ "initializerTokenRange": {
25941
+ "startIndex": 1,
25942
+ "endIndex": 2
25943
+ },
25944
+ "releaseTag": "Public",
25945
+ "name": "verticalDropdownMenu"
25689
25946
  }
25690
25947
  ]
25691
25948
  },
@@ -37431,6 +37688,213 @@
37431
37688
  ],
37432
37689
  "name": "toPickerItem"
37433
37690
  },
37691
+ {
37692
+ "kind": "Class",
37693
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer:class",
37694
+ "docComment": "/**\n * The Vertical Dropdown Menu Renderer element.\n *\n * @remarks\n *\n * For a pinned, icon-only \"more actions\" column that anchors a menu to itself.\n *\n * @tagname\n *\n * %%prefix%%-grid-pro-vertical-dropdown-menu-renderer\n *\n * @public\n */\n",
37695
+ "excerptTokens": [
37696
+ {
37697
+ "kind": "Content",
37698
+ "text": "export declare class VerticalDropdownMenuRenderer extends "
37699
+ },
37700
+ {
37701
+ "kind": "Reference",
37702
+ "text": "FoundationElement",
37703
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
37704
+ },
37705
+ {
37706
+ "kind": "Content",
37707
+ "text": " implements "
37708
+ },
37709
+ {
37710
+ "kind": "Reference",
37711
+ "text": "ICellRendererComp",
37712
+ "canonicalReference": "@ag-grid-community/core!ICellRendererComp:interface"
37713
+ },
37714
+ {
37715
+ "kind": "Content",
37716
+ "text": " "
37717
+ }
37718
+ ],
37719
+ "fileUrlPath": "src/cell-renderers/vertical-dropdown-menu.renderer.ts",
37720
+ "releaseTag": "Public",
37721
+ "isAbstract": false,
37722
+ "name": "VerticalDropdownMenuRenderer",
37723
+ "preserveMemberOrder": false,
37724
+ "members": [
37725
+ {
37726
+ "kind": "Method",
37727
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer#getGui:member(1)",
37728
+ "docComment": "",
37729
+ "excerptTokens": [
37730
+ {
37731
+ "kind": "Content",
37732
+ "text": "getGui(): "
37733
+ },
37734
+ {
37735
+ "kind": "Reference",
37736
+ "text": "HTMLElement",
37737
+ "canonicalReference": "!HTMLElement:interface"
37738
+ },
37739
+ {
37740
+ "kind": "Content",
37741
+ "text": ";"
37742
+ }
37743
+ ],
37744
+ "isStatic": false,
37745
+ "returnTypeTokenRange": {
37746
+ "startIndex": 1,
37747
+ "endIndex": 2
37748
+ },
37749
+ "releaseTag": "Public",
37750
+ "isProtected": false,
37751
+ "overloadIndex": 1,
37752
+ "parameters": [],
37753
+ "isOptional": false,
37754
+ "isAbstract": false,
37755
+ "name": "getGui"
37756
+ },
37757
+ {
37758
+ "kind": "Method",
37759
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer#init:member(1)",
37760
+ "docComment": "",
37761
+ "excerptTokens": [
37762
+ {
37763
+ "kind": "Content",
37764
+ "text": "init(params: "
37765
+ },
37766
+ {
37767
+ "kind": "Reference",
37768
+ "text": "ICellRendererParams",
37769
+ "canonicalReference": "@ag-grid-community/core!ICellRendererParams:interface"
37770
+ },
37771
+ {
37772
+ "kind": "Content",
37773
+ "text": "): "
37774
+ },
37775
+ {
37776
+ "kind": "Content",
37777
+ "text": "void"
37778
+ },
37779
+ {
37780
+ "kind": "Content",
37781
+ "text": ";"
37782
+ }
37783
+ ],
37784
+ "isStatic": false,
37785
+ "returnTypeTokenRange": {
37786
+ "startIndex": 3,
37787
+ "endIndex": 4
37788
+ },
37789
+ "releaseTag": "Public",
37790
+ "isProtected": false,
37791
+ "overloadIndex": 1,
37792
+ "parameters": [
37793
+ {
37794
+ "parameterName": "params",
37795
+ "parameterTypeTokenRange": {
37796
+ "startIndex": 1,
37797
+ "endIndex": 2
37798
+ },
37799
+ "isOptional": false
37800
+ }
37801
+ ],
37802
+ "isOptional": false,
37803
+ "isAbstract": false,
37804
+ "name": "init"
37805
+ },
37806
+ {
37807
+ "kind": "Property",
37808
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer#params:member",
37809
+ "docComment": "",
37810
+ "excerptTokens": [
37811
+ {
37812
+ "kind": "Content",
37813
+ "text": "params: "
37814
+ },
37815
+ {
37816
+ "kind": "Reference",
37817
+ "text": "ICellRendererParams",
37818
+ "canonicalReference": "@ag-grid-community/core!ICellRendererParams:interface"
37819
+ },
37820
+ {
37821
+ "kind": "Content",
37822
+ "text": ";"
37823
+ }
37824
+ ],
37825
+ "isReadonly": false,
37826
+ "isOptional": false,
37827
+ "releaseTag": "Public",
37828
+ "name": "params",
37829
+ "propertyTypeTokenRange": {
37830
+ "startIndex": 1,
37831
+ "endIndex": 2
37832
+ },
37833
+ "isStatic": false,
37834
+ "isProtected": false,
37835
+ "isAbstract": false
37836
+ },
37837
+ {
37838
+ "kind": "Method",
37839
+ "canonicalReference": "@genesislcap/grid-pro!VerticalDropdownMenuRenderer#refresh:member(1)",
37840
+ "docComment": "",
37841
+ "excerptTokens": [
37842
+ {
37843
+ "kind": "Content",
37844
+ "text": "refresh(params: "
37845
+ },
37846
+ {
37847
+ "kind": "Reference",
37848
+ "text": "ICellRendererParams",
37849
+ "canonicalReference": "@ag-grid-community/core!ICellRendererParams:interface"
37850
+ },
37851
+ {
37852
+ "kind": "Content",
37853
+ "text": "): "
37854
+ },
37855
+ {
37856
+ "kind": "Content",
37857
+ "text": "boolean"
37858
+ },
37859
+ {
37860
+ "kind": "Content",
37861
+ "text": ";"
37862
+ }
37863
+ ],
37864
+ "isStatic": false,
37865
+ "returnTypeTokenRange": {
37866
+ "startIndex": 3,
37867
+ "endIndex": 4
37868
+ },
37869
+ "releaseTag": "Public",
37870
+ "isProtected": false,
37871
+ "overloadIndex": 1,
37872
+ "parameters": [
37873
+ {
37874
+ "parameterName": "params",
37875
+ "parameterTypeTokenRange": {
37876
+ "startIndex": 1,
37877
+ "endIndex": 2
37878
+ },
37879
+ "isOptional": false
37880
+ }
37881
+ ],
37882
+ "isOptional": false,
37883
+ "isAbstract": false,
37884
+ "name": "refresh"
37885
+ }
37886
+ ],
37887
+ "extendsTokenRange": {
37888
+ "startIndex": 1,
37889
+ "endIndex": 2
37890
+ },
37891
+ "implementsTokenRanges": [
37892
+ {
37893
+ "startIndex": 3,
37894
+ "endIndex": 4
37895
+ }
37896
+ ]
37897
+ },
37434
37898
  {
37435
37899
  "kind": "Function",
37436
37900
  "canonicalReference": "@genesislcap/grid-pro!wasClickOutsideElement:function(1)",
@@ -167,6 +167,7 @@ import { ValueParserFunc } from '@ag-grid-community/core';
167
167
  import { ValueParserFunc as ValueParserFunc_2 } from 'ag-grid-community';
168
168
  import { ValueSetterFunc } from '@ag-grid-community/core';
169
169
  import { ValueSetterFunc as ValueSetterFunc_2 } from 'ag-grid-community';
170
+ import { VerticalDropdownMenuItem } from '@genesislcap/foundation-ui';
170
171
  import { ViewTemplate } from '@microsoft/fast-element';
171
172
 
172
173
  /**
@@ -2119,6 +2120,13 @@ export declare const foundationGridComponents: {
2119
2120
  baseName: string;
2120
2121
  template: ViewTemplate<any, any>;
2121
2122
  }, ActionsMenuRenderer>;
2123
+ foundationGridProVerticalDropdownMenuRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
2124
+ baseName: string;
2125
+ template: ViewTemplate<any, any>;
2126
+ }>) => FoundationElementRegistry< {
2127
+ baseName: string;
2128
+ template: ViewTemplate<any, any>;
2129
+ }, VerticalDropdownMenuRenderer>;
2122
2130
  foundationAgBooleanRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
2123
2131
  baseName: string;
2124
2132
  styles: ElementStyles;
@@ -2337,6 +2345,21 @@ export declare const foundationGridProShadowOptions: ShadowRootInit;
2337
2345
  */
2338
2346
  export declare const foundationGridProStyles: ElementStyles;
2339
2347
 
2348
+ /**
2349
+ * A function that returns a Foundation Vertical Dropdown Menu for configuring the component with a DesignSystem.
2350
+ *
2351
+ * @public
2352
+ * @remarks
2353
+ * HTML Element: \<foundation-grid-pro-vertical-dropdown-menu-renderer\>
2354
+ */
2355
+ export declare const foundationGridProVerticalDropdownMenuRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
2356
+ baseName: string;
2357
+ template: ViewTemplate<any, any>;
2358
+ }>) => FoundationElementRegistry< {
2359
+ baseName: string;
2360
+ template: ViewTemplate<any, any>;
2361
+ }, typeof VerticalDropdownMenuRenderer>;
2362
+
2340
2363
  /**
2341
2364
  * A function that returns a Foundation Icon Renderer registration for configuring the component with a DesignSystem.
2342
2365
  *
@@ -3522,6 +3545,30 @@ export declare const getTextFieldRendererTemplate: (designSystem?: string) => Vi
3522
3545
  */
3523
3546
  export declare const getTextRendererTemplate: (designSystem?: string) => ViewTemplate<AgTextFieldRenderer, any>;
3524
3547
 
3548
+ /**
3549
+ * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for the
3550
+ * Vertical Dropdown Menu Renderer.
3551
+ * Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).
3552
+ * @param items - Array of `VerticalDropdownMenuItem` to be displayed in the menu, or a function of the row data
3553
+ * returning that array (for row-scoped eligibility/permission filtering).
3554
+ * @param overrideDef - Optional override for the ColDef. Will override any of the default values. Default is an empty object.
3555
+ * @param iconName - Optional icon name for the opener. Default is `'ellipsis-vertical'`.
3556
+ * @param buttonAppearance - Optional appearance for the button that opens the menu.
3557
+ * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for the Vertical Dropdown Menu Renderer.
3558
+ * @example
3559
+ * ```ts
3560
+ * public exampleMoreColumnDef: ColDef = getVerticalDropdownMenuDef(
3561
+ * (rowData) => [
3562
+ * { label: 'Ping Trader', icon: { name: 'paper-plane' }, callback: (rowData) => pingTrader(rowData) },
3563
+ * { label: 'Assign', icon: { name: 'user' }, callback: (rowData) => assign(rowData) },
3564
+ * ],
3565
+ * { headerName: '', pinned: 'right' },
3566
+ * );
3567
+ * ```
3568
+ * @public
3569
+ */
3570
+ export declare const getVerticalDropdownMenuDef: (items: VerticalDropdownMenuItem[] | ((rowData: any) => VerticalDropdownMenuItem[]), overrideDef?: ColDef, iconName?: string, buttonAppearance?: string) => ColDef;
3571
+
3525
3572
  /** Context key on `gridOptions.context` for AG column drag integration.
3526
3573
  * @public
3527
3574
  */
@@ -6902,7 +6949,13 @@ declare const GridProLegacy_base: (new (...args: any[]) => {
6902
6949
  scrollBy(options?: ScrollToOptions): void;
6903
6950
  scrollBy(x: number, y: number): void;
6904
6951
  scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
6905
- scrollTo(options?: ScrollToOptions): void;
6952
+ scrollTo(options? /**
6953
+ * Configuration for the grid status bar components.
6954
+ * @remarks
6955
+ * This requires AG Grid Enterprise module to be enabled.
6956
+ * The status bar will only be displayed if the Enterprise module is available.
6957
+ * @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
6958
+ */: ScrollToOptions): void;
6906
6959
  scrollTo(x: number, y: number): void;
6907
6960
  setAttribute(qualifiedName: string, value: string): void;
6908
6961
  setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
@@ -7158,6 +7211,7 @@ declare const GridProLegacy_base: (new (...args: any[]) => {
7158
7211
  export declare enum GridProRendererTypes {
7159
7212
  action = "action",
7160
7213
  actionsMenu = "actionsMenu",
7214
+ verticalDropdownMenu = "verticalDropdownMenu",
7161
7215
  boolean = "boolean",
7162
7216
  editable = "editable",
7163
7217
  icon = "icon",
@@ -9379,6 +9433,19 @@ declare type UntypeNonFunctions<T> = {
9379
9433
  [K in keyof T]: T[K] extends (...args: any[]) => any ? T[K] : never;
9380
9434
  };
9381
9435
 
9436
+ /**
9437
+ * The Vertical Dropdown Menu Renderer element.
9438
+ * @remarks For a pinned, icon-only "more actions" column that anchors a menu to itself.
9439
+ * @public
9440
+ * @tagname %%prefix%%-grid-pro-vertical-dropdown-menu-renderer
9441
+ */
9442
+ export declare class VerticalDropdownMenuRenderer extends FoundationElement implements ICellRendererComp {
9443
+ params: ICellRendererParams;
9444
+ init(params: ICellRendererParams): void;
9445
+ getGui(): HTMLElement;
9446
+ refresh(params: ICellRendererParams): boolean;
9447
+ }
9448
+
9382
9449
  /**
9383
9450
  * Checks if the given mouse event occurred outside the target element.
9384
9451
  * @public
package/dist/react.cjs CHANGED
@@ -19,6 +19,7 @@ const { SelectRenderer: SelectRendererWC } = require('./esm/cell-renderers/selec
19
19
  const { StatusPillRenderer: StatusPillRendererWC } = require('./esm/cell-renderers/status-pill.renderer.js');
20
20
  const { AgTextFieldRenderer: AgTextFieldRendererWC } = require('./esm/cell-renderers/text-field.renderer.js');
21
21
  const { AgTextRenderer: AgTextRendererWC } = require('./esm/cell-renderers/text.renderer.js');
22
+ const { VerticalDropdownMenuRenderer: VerticalDropdownMenuRendererWC } = require('./esm/cell-renderers/vertical-dropdown-menu.renderer.js');
22
23
  const { GridProCell: GridProCellWC } = require('./esm/cell/cell.js');
23
24
  const { ColumnSelection: ColumnSelectionWC } = require('./esm/column-selection/column-selection.js');
24
25
  const { GridProColumn: GridProColumnWC } = require('./esm/column/column.js');
@@ -163,6 +164,11 @@ const AgTextRenderer = React.forwardRef(function AgTextRenderer(props, ref) {
163
164
  return React.createElement(customElements.getName(AgTextRendererWC) ?? '%%prefix%%-grid-text-renderer', { ...rest, ref }, children);
164
165
  });
165
166
 
167
+ const VerticalDropdownMenuRenderer = React.forwardRef(function VerticalDropdownMenuRenderer(props, ref) {
168
+ const { children, ...rest } = props;
169
+ return React.createElement(customElements.getName(VerticalDropdownMenuRendererWC) ?? '%%prefix%%-grid-pro-vertical-dropdown-menu-renderer', { ...rest, ref }, children);
170
+ });
171
+
166
172
  const GridProColumn = React.forwardRef(function GridProColumn(props, ref) {
167
173
  const { children, ...rest } = props;
168
174
  return React.createElement(customElements.getName(GridProColumnWC) ?? 'grid-pro-column', { ...rest, ref }, children);
@@ -598,6 +604,7 @@ module.exports = {
598
604
  StatusPillRenderer,
599
605
  AgTextFieldRenderer,
600
606
  AgTextRenderer,
607
+ VerticalDropdownMenuRenderer,
601
608
  GridProColumn,
602
609
  ColumnSelection,
603
610
  GridProClientSideDatasource,