ContextMenuOpenEvent

Defines the event arguments passed when the context menu is opened in the grid. Provides context information about the menu trigger, available items, and associated row/column data. Used in context menu event handlers to access information about the menu interaction.

Props

The following table outlines the props for the ContextMenuOpenEvent:

NameTypeDefaultDescription
cancel
boolean
false

Indicates whether the context menu opening event should be cancelled. Setting this to true prevents the context menu from displaying. Used to conditionally suppress context menu display based on application logic or user permissions.

column
undefined

Contains the column configuration object for the column where the context menu was triggered. Provides metadata such as field name, column type, and other column properties. Enables context-aware menu item display and column-specific actions.

data
T
undefined

Contains the complete data object for the row where the context menu was triggered. Provides access to all field values in the row for row-specific menu actions. Used to determine available menu items based on row data state or values.

event
Event
undefined

Specifies the original DOM event that triggered the context menu opening. Provides access to event details such as mouse position, target element, and event modifiers. Useful for custom event handling or determining context menu trigger source.

items
(ContextMenuItem | ContextMenuItemProps)[]
-

Contains the array of context menu items that will be displayed. Includes both default items (via ContextMenuItem) and custom items (via ContextMenuItemProps). Can be inspected or modified to dynamically control which menu items appear.