ContextMenu displays an overlay menu on right click of its target.
import ContextMenu from 'primevue/contextmenu';
ContextMenu requires a collection of menuitems as its model and the show method needs to be called explicity using the contextmenu event of the target to display the menu.
<img alt="Logo" src="/images/nature/nature3.jpg" class="w-full md:w-auto" @contextmenu="onImageRightClick" aria-haspopup="true" /> <ContextMenu ref="menu" :model="items" />
Setting global property attaches the context menu to the document.
Right-Click anywhere on this page to view the global ContextMenu.
<p class="mb-0">Right-Click anywhere on this page to view the global ContextMenu.</p> <ContextMenu global :model="items" />
Following is the list of structural style classes, for theming classes visit theming page.
|p-contextmenu-root-list||Root list element.|
|p-submenu-list||Submenu list element.|
|p-menuitem-active||Active menuitem element.|
|p-menuitem-content||Content of menuitem.|
|p-menuitem-link||Link element of the menuitem.|
|p-menuitem-text||Label of a menuitem.|
|p-menuitem-icon||Icon of a menuitem.|
|p-submenu-icon||Arrow icon of a submenu.|
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 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.
|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.|
|any printable character||Moves focus to the menuitem whose label starts with the characters being typed.|