ContextMenu
ContextMenu displays an overlay menu on right click of its target.
Import #
import { ContextMenuModule } from 'primeng/contextmenu';
Basic #
ContextMenu can be attached to a particular element whose local template variable name is defined using the target property.
<img #img src="https://primefaces.org/cdn/primeng/images/demo/nature/nature3.jpg" alt="Logo" aria-haspopup="true" class="max-w-full">
<p-contextMenu [target]="img" [model]="items"></p-contextMenu>
Document #
Setting global property to true attaches the context menu to the document.
Right-Click anywhere on this page to view the global ContextMenu.
<p-contextMenu [model]="items" [global]="true"></p-contextMenu>
Trigger Event #
Trigger event of context menu can be replaced by a different event with triggerEvent property. Default value of triggerEvent is contextmenu.
<img #img src="https://primefaces.org/cdn/primeng/images/demo/nature/nature3.jpg" alt="Logo" aria-haspopup="true" class="max-w-full">
<p-contextMenu [target]="img" [model]="items" [triggerEvent]="click"></p-contextMenu>
Style #
Following is the list of structural style classes, for theming classes visit theming page.
| Name | Element |
|---|---|
| p-contextmenu | Container element. |
| p-menu-list | List element. |
| p-menuitem | Menuitem element. |
| p-menuitem-text | Label of a menuitem. |
| p-menuitem-icon | Icon of a menuitem. |
| p-submenu-icon | Arrow icon of a submenu. |
Accessibility #
Screen Reader
ContextMenu component uses the menubar role with aria-orientation set to "vertical" and the value to describe the menu can either be provided with aria-labelledby or aria-label props. Each list item has a presentation role whereas anchor elements have a menuitem role with aria-label referring to the label of the item and aria-disabled defined if the item is disabled. A submenu within a ContextMenu uses the menu role with an aria-labelledby defined as the id of the submenu root menuitem label. In addition, menuitems that open a submenu have aria-haspopup, aria-expanded and aria-controls to define the relation between the item and the submenu.
Keyboard Support
| Key | Function |
|---|---|
| tab | When focus is in the menu, closes the context menu and moves focus to the next focusable element in the page sequence. |
| enter | If menuitem has a submenu, toggles the visibility of the submenu otherwise activates the menuitem and closes all open overlays. |
| space | If menuitem has a submenu, toggles the visibility of the submenu otherwise activates the menuitem and closes all open overlays. |
| escape | Closes the context menu. |
| down arrow | If focus is not inside the menu and menu is open, add focus to the first item. If an item is already focused, moves focus to the next menuitem within the submenu. |
| up arrow | If focus is not inside the menu and menu is open, add focus to the last item. If an item is already focused, moves focus to the next menuitem within the submenu. |
| right arrow | Opens a submenu if there is one available and moves focus to the first item. |
| left arrow | Closes a submenu and moves focus to the root item of the closed submenu. |
| home | Moves focus to the first menuitem within the submenu. |
| end | Moves focus to the last menuitem within the submenu. |
ContextMenu API
API defines helper props, events and others for the PrimeNG ContextMenu module.
Properties #
| Name | Type | Default | Description |
|---|---|---|---|
| model | array | null | An array of menuitems. |
| global | boolean | false | Attaches the menu to document instead of a particular item. |
| target | string | null | Local template variable name of the element to attach the context menu. |
| style | string | null | Inline style of the component. |
| styleClass | string | null | Style class of the component. |
| appendTo | any | null | Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name). |
| baseZIndex | number | 0 | Base zIndex value to use in layering. |
| autoZIndex | boolean | true | Whether to automatically manage layering. |
| triggerEvent | string | contextmenu | Event for which the menu must be displayed. |
Methods #
| Name | Parameters | Description |
|---|---|---|
| toggle | event (optional): mouse event | Toggles the visibility of the popup menu. |
| show | event: browser event | Displays the popup menu. |
| hide | - | Hides the popup menu. |
Events #
| Name | Parameters | Description |
|---|---|---|
| onShow | - | Callback to invoke when context menu is shown. |
| onHide | - | Callback to invoke when context menu is hidden. |
MenuItem API #
MenuItem provides the following properties. Note that not all of them may be utilized by the contextmenu component.
| Name | Type | Default | Description |
|---|---|---|---|
| id | string | null | Identifier of the element. |
| label | string | null | Text of the item. |
| icon | string | null | Icon of the item. |
| iconStyle | object | null | Inline style of the item's icon. |
| command | function | null | Callback to execute when item is clicked. |
| url | string | null | External link to navigate when item is clicked. |
| routerLink | array | null | RouterLink definition for internal navigation. |
| routerLinkActiveOptions | object | null | Configuration for active router link. |
| queryParams | object | null | Query parameters for internal navigation via routerLink. |
| fragment | string | null | Sets the hash fragment for the URL. |
| queryParamsHandling | QueryParamsHandling | null | How to handle query parameters in the router link for the next navigation. One of: merge : Merge new with current parameters. preserve : Preserve current parameters.k. |
| preserveFragment | boolean | false | When true, preserves the URL fragment for the next navigation. |
| skipLocationChange | boolean | null | When true, navigates without pushing a new state into history. |
| replaceUrl | boolean | null | When true, navigates while replacing the current state in history. |
| state | object | null | Developer-defined state that can be passed to any navigation. |
| items | array | null | An array of children menuitems. |
| expanded | boolean | false | Visibility of submenu. |
| disabled | boolean | false | When set as true, disables the menuitem. |
| visible | boolean | true | Whether the dom element of menuitem is created or not. |
| target | string | null | Specifies where to open the linked document. |
| escape | boolean | true | Whether to escape the label or not. Set to false to display html content. |
| separator | boolean | false | Defines the item as a separator. |
| style | object | null | Inline style of the menuitem. |
| styleClass | string | null | Style class of the menuitem. |
| badge | string | null | Value of the badge. |
| badgeStyleClass | string | null | Style class of the badge. |
| title | string | null | Tooltip text of the item. |
| automationId | any | null | Value of HTML data-* attribute. |
| tabindex | string | 0 | Specifies tab order of the item. |
| tooltipOptions | TooltipOptions | - | Options of the item's tooltip. |