UserColumnMenuItem
Column Menu Item that is provided by User
export interfaceProperties
| Property | Type | Description |
|---|---|---|
| disabled | boolean | Whether menu item is disabled |
| frameworkComponent | MenuItemFrameworkComponent<ColumnMenuContext> | Optional Framework Component (React, Angular or Vue) used to render the content of this menu item. When supplied, AG Grid renders the component inside the menu row using its own framework adapter. The component receives AG Grid's CustomMenuItemProps, with the AdapTable-specific extras( adaptableApi, menuContext, plus anything passed viamenuItemParams) available as props.menuItemParams.Supported in the React, Vue and Angular variants of AdapTable. For Vue, supply a factory that returns the Vue Component (NOT a render call), e.g. ({ adaptableApi }) => MyMenuItem. AG Grid Vue theninstantiates the component using its own framework adapter and passes name, icon, menuItemParams, ... as props.For Angular, supply { type: MyMenuItemComponent } where the componentimplements IMenuItemAngularComp (with agInit(params) to receiveparams.menuItemParams.adaptableApi and params.menuItemParams.menuContext).The onSetup callback on AngularFrameworkComponent is NOT honouredfor menu items because AG Grid owns the component lifecycle. |
| hidden | boolean | Whether menu item is hidden |
| icon | AdaptableIcon | Optional icon to display |
| label | string | Text to appear in the Menu Item |
| menuItemParams | Record<string, unknown> | Extra parameters passed through to the Framework Component (alongsideadaptableApi and menuContext). |
| menuType | 'User' | Type of Menu - always 'User' |
| onClick | (menuContext:ColumnMenuContext) => void | Function invoked when the Menu Item is clicked |
| subMenuItems | CustomColumnMenuItem[] | Array of Menu Items, enabling limitless levels of menus |
Property Details
disabled
Whether menu item is disabled
disabled?: boolean;Property Value
boolean
frameworkComponent
Optional Framework Component (React, Angular or Vue) used to render the content of this menu item.
When supplied, AG Grid renders the component inside the menu row using
its own framework adapter. The component receives AG Grid's
CustomMenuItemProps, with the AdapTable-specific extras
(adaptableApi, menuContext, plus anything passed via
menuItemParams) available as props.menuItemParams.
Supported in the React, Vue and Angular variants of AdapTable.
For Vue, supply a factory that returns the Vue Component (NOT a render
call), e.g. ({ adaptableApi }) => MyMenuItem. AG Grid Vue then
instantiates the component using its own framework adapter and passes
name, icon, menuItemParams, ... as props.
For Angular, supply { type: MyMenuItemComponent } where the component
implements IMenuItemAngularComp (with agInit(params) to receive
params.menuItemParams.adaptableApi and params.menuItemParams.menuContext).
The onSetup callback on AngularFrameworkComponent is NOT honoured
for menu items because AG Grid owns the component lifecycle.
frameworkComponent?: MenuItemFrameworkComponent<ColumnMenuContext>;Property Value
MenuItemFrameworkComponent<ColumnMenuContext>
hidden
Whether menu item is hidden
hidden?: boolean;Property Value
boolean
icon
Optional icon to display
icon?: AdaptableIcon;Property Value
label
Text to appear in the Menu Item
label: string;Property Value
string
menuItemParams
Extra parameters passed through to the Framework Component (alongside
adaptableApi and menuContext).
menuItemParams?: Record<string, unknown>;Property Value
Record<string, unknown>
menuType
Type of Menu - always 'User'
menuType: 'User';Property Value
'User'
onClick
Function invoked when the Menu Item is clicked
onClick?: (menuContext: ColumnMenuContext) => void;Property Value
(menuContext:ColumnMenuContext) => void
subMenuItems
Array of Menu Items, enabling limitless levels of menus
subMenuItems?: CustomColumnMenuItem[];