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/nature2.jpg" 
    alt="Logo" 
    aria-haspopup="true" 
    class="max-w-full" />
<p-contextmenu [target]="img" [model]="items" />

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" />

Template #

ContextMenu offers item customization with the item template that receives the menuitem instance from the model as a parameter.

Bamboo Watch
Accessories
$65
Black Watch
Accessories
$72
Blue Band
Fitness
$79
Blue T-Shirt
Clothing
$29
Bracelet
Accessories
$15


<ul
    class="m-0 p-0 list-none border border-surface-200 dark:border-surface-700 rounded p-4 flex flex-col gap-2 w-full md:w-[30rem]"
>
    <li
        *ngFor="let product of data"
        class="p-2 hover:bg-surface-100 dark:hover:bg-surface-800 rounded border border-transparent transition-all transition-duration-200"
        [ngClass]="{ 'border-primary': selectedId === product.id }"
        (contextmenu)="onContextMenu($event)"
    >
        <div class="flex flex-wrap p-2 items-center gap-4">
            <img
                class="w-16 shrink-0 rounded"
                src="https://primefaces.org/cdn/primeng/images/demo/product/{{ product.image }}"
                [alt]="product.name"
            />
            <div class="flex-1 flex flex-col gap-1">
                <span class="font-bold">{{ product.name }}</span>
                <div class="flex items-center gap-2">
                    <i class="pi pi-tag text-sm"></i>
                    <span>{{ product.category }}</span>
                </div>
            </div>
            <span class="font-bold ml-8">&#36;{{ product.price }}</span>
        </div>
    </li>
</ul>

<p-contextmenu #cm [model]="items" (onHide)="onHide()">
    <ng-template pTemplate="item" let-item>
        <a pRipple class="flex items-center p-contextmenu-item-link">
            <span [class]="item.icon"></span>
            <span class="ml-2">{{ item.label }}</span>
            <p-badge *ngIf="item.badge" class="ml-auto" [value]="item.badge" />
            <span
                *ngIf="item.shortcut"
                class="ml-auto border border-surface rounded bg-emphasis text-muted-color text-xs p-1"
                >{{ item.shortcut }}</span
            >
            <i *ngIf="item.items" class="pi pi-angle-right ml-auto"></i>
        </a>
    </ng-template>
</p-contextmenu>

Command #

The function to invoke when an item is clicked is defined using the command property.

Amy Elsner
Admin
Anna Fali
Member
Asiya Javayant
Member
Bernardo Dominic
Guest
Elwin Sharvill
Member


<p-toast />
    <ul class="m-0 list-none border border-surface rounded p-4 flex flex-col gap-2 w-full sm:w-96">
        <li
            *ngFor="let user of users"
            class="p-2 hover:bg-emphasis rounded border border-transparent transition-all duration-200 flex items-center justify-content-between"
            [ngClass]="{ 'border-primary': selectedId === user.id }"
            (contextmenu)="onContextMenu($event, user)"
        >
            <div class="flex flex-1 items-center gap-2">
                <img
                    class="w-8 h-8"
                    [alt]="user.name"
                    [src]="'https://primefaces.org/cdn/primeng/images/demo/avatar/' + user.image"
                />
                <span class="font-bold">{{ user.name }}</span>
            </div>
            <p-tag [value]="user.role" [severity]="getBadge(user)" />
        </li>
    </ul>

    <p-contextmenu #cm [model]="items" (onHide)="onHide()" />

Router #

ContextMenu can be attached to a particular element whose local template variable name is defined using the target property.


<span
    #span
    class="inline-flex items-center justify-center border-2 border-primary rounded w-16 h-16"
    aria-haspopup="true"
>
    <svg width="31" height="33" viewBox="0 0 31 33" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path
            d="..."
            fill="var(--p-primary-color)"
        />
        <mask
            id="mask0_1_52"
            style="mask-type:luminance"
            maskUnits="userSpaceOnUse"
            x="0"
            y="0"
            width="31"
            height="33"
        >
            <path
                d="..."
                fill="var(--high-contrast-text-color)"
            />
        </mask>
        <g mask="url(#mask0_1_52)">
            <path
                fill-rule="evenodd"
                clip-rule="evenodd"
                d="..."
                fill="var(--p-primary-color)"
            />
        </g>
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            fill-rule="evenodd"
            clip-rule="evenodd"
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            fill-rule="evenodd"
            clip-rule="evenodd"
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
        <path
            d="..."
            fill="var(--high-contrast-text-color)"
        />
    </svg>
</span>
<p-contextmenu [target]="span" [model]="items">
    <ng-template pTemplate="item" let-item>
        <ng-container *ngIf="item.route; else elseBlock">
            <a [routerLink]="item.route" class="p-contextmenu-item-link">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
        </ng-container>
        <ng-template #elseBlock>
            <a [href]="item.url" class="p-contextmenu-item-link">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
        </ng-template>
    </ng-template>
</p-contextmenu>

Table #

Table has built-in support for ContextMenu, see the ContextMenu demo for an example.

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.

name	type	default	description
model	MenuItem[]	null	An array of menuitems.
triggerEvent	string	contextmenu	Event for which the menu must be displayed.
target	string \| HTMLElement	null	Local template variable name of the element to attach the context menu.
global	boolean	false	Attaches the menu to document instead of a particular item.
style	Object	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.
autoZIndex	boolean	true	Whether to automatically manage layering.
baseZIndex	number	0	Base zIndex value to use in layering.
id	string	null	Current id state as a string.
ariaLabel	string	null	Defines a string value that labels an interactive element.
ariaLabelledBy	string	null	Identifier of the underlying input element.
pressDelay	number	500	Press delay in touch devices as miliseconds.

name	parameters	description
onShow	value : null	Callback to invoke when overlay menu is shown.
onHide	value : null	Callback to invoke when overlay menu is hidden.

name	parameters	description
item	context : { $implicit: MenuItem, // Item instance. }	Custom item template.
submenuicon	context : { class: string, // Style class of the submenu icon. }	Custom template of submenuicon.

name	type	description
label	string	Text of the item.
icon	string	Icon of the item.
command	-
url	string	External link to navigate when item is clicked.
items	MenuItem[]	An array of children menuitems.
expanded	boolean	Visibility of submenu.
disabled	boolean	When set as true, disables the menuitem.
visible	boolean	Whether the dom element of menuitem is created or not.
target	string	Specifies where to open the linked document.
escape	boolean	Whether to escape the label or not. Set to false to display html content.
routerLinkActiveOptions	any	Configuration for active router link.
separator	boolean	Defines the item as a separator.
badge	string	Value of the badge.
tooltip	string	Tooltip of the item.
tooltipPosition	string	Position of the tooltip item.
badgeStyleClass	string	Style class of the badge.
style	Object	Inline style of the menuitem.
styleClass	string	Style class of the menuitem.
title	string	Tooltip text of the item.
id	string	Identifier of the element.
automationId	any	Value of HTML data-* attribute.
tabindex	string	Specifies tab order of the item.
routerLink	any	RouterLink definition for internal navigation.
queryParams	Object	Query parameters for internal navigation via routerLink.
fragment	string	Sets the hash fragment for the URL.
queryParamsHandling	QueryParamsHandling	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	When true, preserves the URL fragment for the next navigation.
skipLocationChange	boolean	When true, navigates without pushing a new state into history.
replaceUrl	boolean	When true, navigates while replacing the current state in history.
iconStyle	Object	Inline style of the item's icon.
iconClass	string	Class of the item's icon.
state	Object	Developer-defined state that can be passed to any navigation.
tooltipOptions	TooltipOptions	Options of the item's tooltip.

class	description
p-contextmenu	Class name of the root element
p-contextmenu-root-list	Class name of the root list element
p-contextmenu-item	Class name of the item element
p-contextmenu-item-content	Class name of the item content element
p-contextmenu-item-link	Class name of the item link element
p-contextmenu-item-icon	Class name of the item icon element
p-contextmenu-item-label	Class name of the item label element
p-contextmenu-submenu-icon	Class name of the submenu icon element
p-contextmenu-submenu	Class name of the submenu element
p-contextmenu-separator	Class name of the separator element

ContextMenu

Import #

Basic #

Document #

Template #

Command #

Router #

Table #

Accessibility #

Screen Reader

Keyboard Support

ContextMenu API

ContextMenu #

Properties #

Emitters #

Templates #

Interfaces #

MenuItem #

ContextMenu Theming

CSS Classes #

ContextMenu Design Tokens #

token	variable	description
root.background	--p-contextmenu-background	Background of root
root.borderColor	--p-contextmenu-border-color	Border color of root
root.color	--p-contextmenu-color	Color of root
root.borderRadius	--p-contextmenu-border-radius	Border radius of root
root.shadow	--p-contextmenu-shadow	Shadow of root
root.transitionDuration	--p-contextmenu-transition-duration	Transition duration of root
list.padding	--p-contextmenu-list-padding	Padding of list
list.gap	--p-contextmenu-list-gap	Gap of list
item.focusBackground	--p-contextmenu-item-focus-background	Focus background of item
item.activeBackground	--p-contextmenu-item-active-background	Active background of item
item.color	--p-contextmenu-item-color	Color of item
item.focusColor	--p-contextmenu-item-focus-color	Focus color of item
item.activeColor	--p-contextmenu-item-active-color	Active color of item
item.padding	--p-contextmenu-item-padding	Padding of item
item.borderRadius	--p-contextmenu-item-border-radius	Border radius of item
item.gap	--p-contextmenu-item-gap	Gap of item
icon.color	--p-contextmenu-item-icon-color	Icon color of item
icon.focusColor	--p-contextmenu-item-icon-focus-color	Icon focus color of item
icon.activeColor	--p-contextmenu-item-icon-active-color	Icon active color of item
submenuIcon.size	--p-contextmenu-submenu-icon-size	Size of submenu icon
submenuIcon.color	--p-contextmenu-submenu-icon-color	Color of submenu icon
submenuIcon.focusColor	--p-contextmenu-submenu-icon-focus-color	Focus color of submenu icon
submenuIcon.activeColor	--p-contextmenu-submenu-icon-active-color	Active color of submenu icon
separator.borderColor	--p-contextmenu-separator-border-color	Border color of separator