Blazorise Context Menu API
Explore the Blazorise Context Menu API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Context Menu documentation.
API
Parameters
ContextMenu
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenu. | ||
CloseOnClick | true | bool |
Closes the menu when a regular item is clicked. | ||
CloseOnEscape | true | bool |
Closes the menu when pressing the Escape key. | ||
CloseOnOutsideClick | true | bool |
Closes the menu when clicking outside of it. | ||
Disabled | false | bool |
Prevents the menu from opening through its observed target. | ||
SubmenuHoverCloseDelay | 300 | int |
Delay in milliseconds before hiding a hover-opened submenu after the mouse leaves it. | ||
SubmenuTrigger | All | DropdownTrigger |
Defines which pointer interactions can open or close nested submenus. Possible values: NoneClickHoverAll | ||
TargetId | — | string |
Specifies an element id that opens this context menu when right-clicked. | ||
TargetSelector | — | string |
Specifies a CSS selector that opens this context menu when a matching element is right-clicked. | ||
Visible | false | bool |
Gets or sets whether the menu is visible. Setting this to true opens the menu relative to its configured target. Use Double) to open the menu at a specific viewport position. | ||
ContextMenuToggle
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuToggle. | ||
ContextMenuBody
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuBody. | ||
ContextMenuItem
| Parameter | Default | Type |
|---|---|---|
Active | false | bool |
Indicates the currently active item. | ||
Checked | false | bool |
Tracks the checked state whenever the item is in checkbox mode. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuItem. | ||
Disabled | false | bool |
Indicates the currently disabled item. | ||
Icon | null | object |
Specifies the icon to render before the item content. | ||
Shortcut | — | string |
Specifies shortcut text rendered at the end of the item. | ||
ShowCheckbox | false | bool |
The item renders a checkbox. | ||
Value | null | object |
Holds the item value. | ||
ContextMenuToolbar
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuToolbar. | ||
ContextMenuToolbarItem
| Parameter | Default | Type |
|---|---|---|
Active | false | bool |
Indicates the currently active item. | ||
Disabled | false | bool |
Indicates the currently disabled item. | ||
EndAligned | false | bool |
Pushes this item and any following items to the logical end of the toolbar. | ||
Icon | null | object |
Specifies the icon to render inside the toolbar item. | ||
ShowText | false | bool |
Indicates whether Text should be rendered visibly next to the icon. | ||
Text | — | string |
Specifies the toolbar item text. It is used as the default title and aria-label. | ||
Value | null | object |
Holds the item value. | ||
ContextMenuHeader
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuHeader. | ||
ContextMenuGroup
| Parameter | Default | Type |
|---|---|---|
CheckMode | ContextMenuCheckMode.None | ContextMenuCheckMode |
Defines how child items handle checked state. Possible values: NoneRadio | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuGroup. | ||
SelectedValue | null | object |
Gets or sets the currently selected value when CheckMode is Radio. | ||
ContextMenuSubmenu
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this ContextMenuSubmenu. | ||
Disabled | false | bool |
Indicates the submenu is disabled. | ||
HoverCloseDelay | 300 | int? |
Delay in milliseconds before hiding this hover-opened submenu after the mouse leaves it. When omitted, uses the parent ContextMenu submenu close delay, falling back to 300 ms. | ||
Icon | null | object |
Specifies the icon to render before the submenu label. | ||
Text | — | string |
Specifies the submenu label. | ||
Trigger | All | DropdownTrigger? |
Defines which pointer interactions can open or close this submenu. When omitted, uses the parent ContextMenu submenu trigger, falling back to All. | ||
Events
ContextMenu
| Event | Type |
|---|---|
Closed | EventCallback<ContextMenuEventArgs> |
Occurs after the menu closes. | |
Closing | Func<ContextMenuClosingEventArgs, Task> |
Callback invoked before the menu closes. Set Cancel to prevent closing. | |
Opened | EventCallback<ContextMenuEventArgs> |
Occurs after the menu body has rendered and its initial position has been applied. | |
Opening | Func<ContextMenuOpeningEventArgs, Task> |
Callback invoked before the menu opens. Set Cancel to prevent opening. | |
VisibleChanged | EventCallback<bool> |
Notifies when the effective menu visibility changes or a canceled request must be synchronized. | |
ContextMenuItem
| Event | Type |
|---|---|
CheckedChanged | EventCallback<bool> |
Occurs after the checked state changes whenever the item is in checkbox mode. | |
Clicked | EventCallback<object> |
Notifies when the item is clicked. | |
ContextMenuToolbarItem
| Event | Type |
|---|---|
Clicked | EventCallback<object> |
Notifies when the toolbar item is clicked. | |
ContextMenuGroup
| Event | Type |
|---|---|
SelectedValueChanged | EventCallback<object> |
Occurs after the selected value changes. | |
Methods
ContextMenu
| Method | Return | Parameters |
|---|---|---|
Hide | Task | — |
Hides the context menu.
| ||
Reposition | Task | — |
Repositions the visible context menu relative to its configured target.
This method does nothing while the menu is hidden and does not invoke Opening, Opened, or VisibleChanged. | ||
Reposition | Task | double clientX, double clientY |
Repositions the visible context menu at the supplied viewport coordinates.
This method does nothing while the menu is hidden and does not invoke Opening, Opened, or VisibleChanged. | ||
Show | Task | — |
Opens the context menu relative to its configured target.
This method does nothing while the menu is visible. Use Reposition to update its position. | ||
Show | Task | double clientX, double clientY |
Opens the context menu at the supplied viewport coordinates.
This method does nothing while the menu is visible. Use Double) to update its position. | ||