primeng
Version:
PrimeNG is an open source UI library for Angular featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeB
879 lines (875 loc) • 82.3 kB
JavaScript
export * from 'primeng/types/contextmenu';
import * as i1 from '@angular/common';
import { CommonModule, isPlatformBrowser } from '@angular/common';
import * as i0 from '@angular/core';
import { Injectable, InjectionToken, EventEmitter, signal, inject, forwardRef, numberAttribute, booleanAttribute, ViewChild, Output, Input, Inject, ViewEncapsulation, Component, input, computed, effect, ContentChildren, ContentChild, ChangeDetectionStrategy, NgModule } from '@angular/core';
import * as i2 from '@angular/router';
import { RouterModule } from '@angular/router';
import { resolve, isNotEmpty, getOffset, getViewport, getHiddenElementOuterWidth, getOuterWidth, calculateScrollbarWidth, uuid, isIOS, isAndroid, focus, isPrintableCharacter, isEmpty, findSingle, appendChild, getHiddenElementOuterHeight, findLastIndex } from '@primeuix/utils';
import * as i7 from 'primeng/api';
import { SharedModule, PrimeTemplate } from 'primeng/api';
import * as i5 from 'primeng/badge';
import { BadgeModule } from 'primeng/badge';
import { BaseComponent, PARENT_INSTANCE } from 'primeng/basecomponent';
import * as i4 from 'primeng/bind';
import { BindModule } from 'primeng/bind';
import { AngleRightIcon } from 'primeng/icons';
import * as i6 from 'primeng/motion';
import { MotionModule } from 'primeng/motion';
import { Ripple } from 'primeng/ripple';
import * as i3 from 'primeng/tooltip';
import { TooltipModule } from 'primeng/tooltip';
import { ZIndexUtils } from 'primeng/utils';
import { style } from '@primeuix/styles/contextmenu';
import { BaseStyle } from 'primeng/base';
const inlineStyles = {
root: { position: 'absolute' }
};
const classes = {
root: () => ['p-contextmenu p-component'],
rootList: 'p-contextmenu-root-list',
item: ({ instance, processedItem }) => [
'p-contextmenu-item',
{
'p-contextmenu-item-active': instance.isItemActive(processedItem),
'p-focus': instance.isItemFocused(processedItem),
'p-disabled': instance.isItemDisabled(processedItem),
'p-contextmenu-mobile': instance.queryMatches
}
],
itemContent: 'p-contextmenu-item-content',
itemLink: 'p-contextmenu-item-link',
itemIcon: 'p-contextmenu-item-icon',
itemLabel: 'p-contextmenu-item-label',
submenuIcon: 'p-contextmenu-submenu-icon',
submenu: 'p-contextmenu-submenu',
separator: 'p-contextmenu-separator'
};
class ContextMenuStyle extends BaseStyle {
name = 'contextmenu';
style = style;
classes = classes;
inlineStyles = inlineStyles;
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.0.5", ngImport: i0, type: ContextMenuStyle, deps: null, target: i0.ɵɵFactoryTarget.Injectable });
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.0.5", ngImport: i0, type: ContextMenuStyle });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.0.5", ngImport: i0, type: ContextMenuStyle, decorators: [{
type: Injectable
}] });
/**
*
* ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.
* Refer to documentation of the individual documentation of the with context menu support.
*
* [Live Demo](https://www.primeng.org/contextmenu/)
*
* @module contextmenustyle
*
*/
var ContextMenuClasses;
(function (ContextMenuClasses) {
/**
* Class name of the root element
*/
ContextMenuClasses["root"] = "p-contextmenu";
/**
* Class name of the root list element
*/
ContextMenuClasses["rootList"] = "p-contextmenu-root-list";
/**
* Class name of the item element
*/
ContextMenuClasses["item"] = "p-contextmenu-item";
/**
* Class name of the item content element
*/
ContextMenuClasses["itemContent"] = "p-contextmenu-item-content";
/**
* Class name of the item link element
*/
ContextMenuClasses["itemLink"] = "p-contextmenu-item-link";
/**
* Class name of the item icon element
*/
ContextMenuClasses["itemIcon"] = "p-contextmenu-item-icon";
/**
* Class name of the item label element
*/
ContextMenuClasses["itemLabel"] = "p-contextmenu-item-label";
/**
* Class name of the submenu icon element
*/
ContextMenuClasses["submenuIcon"] = "p-contextmenu-submenu-icon";
/**
* Class name of the submenu element
*/
ContextMenuClasses["submenu"] = "p-contextmenu-submenu";
/**
* Class name of the separator element
*/
ContextMenuClasses["separator"] = "p-contextmenu-separator";
})(ContextMenuClasses || (ContextMenuClasses = {}));
const CONTEXTMENU_INSTANCE = new InjectionToken('CONTEXTMENU_INSTANCE');
const CONTEXTMENUSUB_INSTANCE = new InjectionToken('CONTEXTMENUSUB_INSTANCE');
class ContextMenuSub extends BaseComponent {
el;
renderer;
contextMenu;
get visible() {
return this._visible;
}
set visible(value) {
this._visible = value;
if (this._visible || this.root) {
this.render.set(true);
}
}
items;
itemTemplate;
root = false;
autoZIndex = true;
baseZIndex = 0;
popup;
menuId;
ariaLabel;
ariaLabelledBy;
level = 0;
focusedItemId;
activeItemPath;
motionOptions;
tabindex = 0;
itemClick = new EventEmitter();
itemMouseEnter = new EventEmitter();
menuFocus = new EventEmitter();
menuBlur = new EventEmitter();
menuKeydown = new EventEmitter();
sublistViewChild;
render = signal(false, ...(ngDevMode ? [{ debugName: "render" }] : []));
hostName = 'ContextMenu';
_componentStyle = inject(ContextMenuStyle);
$pcContextMenu = inject(CONTEXTMENU_INSTANCE, { optional: true, skipSelf: true }) ?? undefined;
$pcContextMenuSub = inject(CONTEXTMENUSUB_INSTANCE, { optional: true, skipSelf: true }) ?? undefined;
_visible = false;
constructor(el, renderer, contextMenu) {
super();
this.el = el;
this.renderer = renderer;
this.contextMenu = contextMenu;
this.contextMenu.handleSubmenuAfterLeave = () => {
if (this.root) {
this.onAfterLeave();
}
};
}
getItemProp(processedItem, name, params = null) {
return processedItem && processedItem.item ? resolve(processedItem.item[name], params) : undefined;
}
getItemId(processedItem) {
return processedItem.item && processedItem.item?.id ? processedItem.item.id : `${this.menuId}_${processedItem.key}`;
}
getItemKey(processedItem) {
return this.getItemId(processedItem);
}
getItemLabel(processedItem) {
return this.getItemProp(processedItem, 'label');
}
getAriaSetSize() {
return this.items.filter((processedItem) => this.isItemVisible(processedItem) && !this.getItemProp(processedItem, 'separator')).length;
}
getAriaPosInset(index) {
return index - this.items.slice(0, index).filter((processedItem) => this.isItemVisible(processedItem) && this.getItemProp(processedItem, 'separator')).length + 1;
}
isItemVisible(processedItem) {
return this.getItemProp(processedItem, 'visible') !== false;
}
isItemActive(processedItem) {
if (this.activeItemPath) {
return this.activeItemPath.some((path) => path.key === processedItem.key);
}
}
isItemDisabled(processedItem) {
return this.getItemProp(processedItem, 'disabled');
}
isItemFocused(processedItem) {
return this.focusedItemId === this.getItemId(processedItem);
}
isItemGroup(processedItem) {
return isNotEmpty(processedItem.items);
}
onItemMouseEnter(param) {
const { event, processedItem } = param;
this.itemMouseEnter.emit({ originalEvent: event, processedItem });
}
onItemClick(event, processedItem) {
this.getItemProp(processedItem, 'command', { originalEvent: event, item: processedItem.item });
this.itemClick.emit({ originalEvent: event, processedItem, isFocus: true });
}
onBeforeEnter(event) {
this.position(event.element);
}
onAfterLeave() {
this.render.set(false);
}
// TODO: will be removed later. Helper method to get PT from parent ContextMenu if available, otherwise use own PT
_ptm(section, options) {
return this.$pcContextMenu ? this.$pcContextMenu.ptm(section, options) : this.ptm(section, options);
}
getPTOptions(processedItem, index, key) {
return this._ptm(key, {
context: {
item: processedItem.item,
index: index,
active: this.isItemActive(processedItem),
focused: this.isItemFocused(processedItem),
disabled: this.isItemDisabled(processedItem)
}
});
}
position(sublist) {
const parentItem = sublist.parentElement.parentElement;
const containerOffset = getOffset(sublist.parentElement.parentElement);
const viewport = getViewport();
const sublistWidth = sublist.offsetParent ? sublist.offsetWidth : getHiddenElementOuterWidth(sublist);
const itemOuterWidth = getOuterWidth(parentItem.children[0]);
sublist.style.top = '0px';
if (parseInt(containerOffset.left, 10) + itemOuterWidth + sublistWidth > viewport.width - calculateScrollbarWidth()) {
sublist.style.left = -1 * sublistWidth + 'px';
}
else {
sublist.style.left = itemOuterWidth + 'px';
}
}
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.0.5", ngImport: i0, type: ContextMenuSub, deps: [{ token: i0.ElementRef }, { token: i0.Renderer2 }, { token: forwardRef(() => ContextMenu) }], target: i0.ɵɵFactoryTarget.Component });
static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "21.0.5", type: ContextMenuSub, isStandalone: true, selector: "p-contextMenuSub, p-contextmenu-sub", inputs: { visible: "visible", items: "items", itemTemplate: "itemTemplate", root: ["root", "root", booleanAttribute], autoZIndex: ["autoZIndex", "autoZIndex", booleanAttribute], baseZIndex: ["baseZIndex", "baseZIndex", numberAttribute], popup: ["popup", "popup", booleanAttribute], menuId: "menuId", ariaLabel: "ariaLabel", ariaLabelledBy: "ariaLabelledBy", level: ["level", "level", numberAttribute], focusedItemId: "focusedItemId", activeItemPath: "activeItemPath", motionOptions: "motionOptions", tabindex: ["tabindex", "tabindex", numberAttribute] }, outputs: { itemClick: "itemClick", itemMouseEnter: "itemMouseEnter", menuFocus: "menuFocus", menuBlur: "menuBlur", menuKeydown: "menuKeydown" }, providers: [ContextMenuStyle, { provide: CONTEXTMENUSUB_INSTANCE, useExisting: ContextMenuSub }, { provide: PARENT_INSTANCE, useExisting: ContextMenuSub }], viewQueries: [{ propertyName: "sublistViewChild", first: true, predicate: ["sublist"], descendants: true }], usesInheritance: true, ngImport: i0, template: `
@if (render()) {
<ul
#sublist
role="menu"
[class]="root ? cx('rootList') : cx('submenu')"
[pBind]="_ptm(root ? 'rootList' : 'submenu')"
[attr.id]="menuId + '_list'"
[tabindex]="tabindex"
[attr.aria-label]="ariaLabel"
[attr.aria-labelledBy]="ariaLabelledBy"
[attr.aria-activedescendant]="focusedItemId"
[attr.aria-orientation]="'vertical'"
(keydown)="menuKeydown.emit($event)"
(focus)="menuFocus.emit($event)"
(blur)="menuBlur.emit($event)"
[pMotion]="root ? true : visible"
[pMotionAppear]="true"
[pMotionName]="'p-anchored-overlay'"
[pMotionOptions]="motionOptions"
(pMotionOnBeforeEnter)="onBeforeEnter($event)"
(pMotionOnAfterLeave)="onAfterLeave()"
>
<ng-template ngFor let-processedItem [ngForOf]="items" let-index="index">
<li
*ngIf="isItemVisible(processedItem) && getItemProp(processedItem, 'separator')"
[attr.id]="getItemId(processedItem)"
[style]="getItemProp(processedItem, 'style')"
[class]="cn(cx('separator'), getItemProp(processedItem, 'styleClass'))"
role="separator"
[pBind]="_ptm('separator')"
></li>
<li
#listItem
*ngIf="isItemVisible(processedItem) && !getItemProp(processedItem, 'separator')"
role="menuitem"
[attr.id]="getItemId(processedItem)"
[attr.data-p-highlight]="isItemActive(processedItem)"
[attr.data-p-focused]="isItemFocused(processedItem)"
[attr.data-p-disabled]="isItemDisabled(processedItem)"
[attr.aria-label]="getItemLabel(processedItem)"
[attr.aria-disabled]="isItemDisabled(processedItem) || undefined"
[attr.aria-haspopup]="isItemGroup(processedItem) && !getItemProp(processedItem, 'to') ? 'menu' : undefined"
[attr.aria-expanded]="isItemGroup(processedItem) ? isItemActive(processedItem) : undefined"
[attr.aria-level]="level + 1"
[attr.aria-setsize]="getAriaSetSize()"
[attr.aria-posinset]="getAriaPosInset(index)"
[style]="getItemProp(processedItem, 'style')"
[class]="cn(cx('item', { instance: this, processedItem }), getItemProp(processedItem, 'styleClass'))"
[pBind]="getPTOptions(processedItem, index, 'item')"
pTooltip
[tooltipOptions]="getItemProp(processedItem, 'tooltipOptions')"
[pTooltipUnstyled]="unstyled()"
>
<div [class]="cx('itemContent')" [pBind]="getPTOptions(processedItem, index, 'itemContent')" (click)="onItemClick($event, processedItem)" (mouseenter)="onItemMouseEnter({ $event, processedItem })">
<ng-container *ngIf="!itemTemplate">
<a
*ngIf="!getItemProp(processedItem, 'routerLink')"
[attr.href]="getItemProp(processedItem, 'url')"
[attr.data-automationid]="getItemProp(processedItem, 'automationId')"
[attr.title]="getItemProp(processedItem, 'title')"
[target]="getItemProp(processedItem, 'target')"
[class]="cn(cx('itemLink'), getItemProp(processedItem, 'linkClass'))"
[ngStyle]="getItemProp(processedItem, 'linkStyle')"
[attr.tabindex]="-1"
[pBind]="getPTOptions(processedItem, index, 'itemLink')"
pRipple
>
<span
*ngIf="getItemProp(processedItem, 'icon')"
[class]="cn(cx('itemIcon'), getItemProp(processedItem, 'icon'), getItemProp(processedItem, 'iconClass'))"
[ngStyle]="getItemProp(processedItem, 'iconStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemIcon')"
[attr.aria-hidden]="true"
[attr.tabindex]="-1"
>
</span>
<span
*ngIf="getItemProp(processedItem, 'escape'); else htmlLabel"
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
>
{{ getItemLabel(processedItem) }}
</span>
<ng-template #htmlLabel>
<span
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[innerHTML]="getItemLabel(processedItem)"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
></span>
</ng-template>
<p-badge *ngIf="getItemProp(processedItem, 'badge')" [class]="getItemProp(processedItem, 'badgeStyleClass')" [value]="getItemProp(processedItem, 'badge')" [unstyled]="unstyled()" />
<ng-container *ngIf="isItemGroup(processedItem)">
<svg
data-p-icon="angle-right"
*ngIf="!contextMenu.submenuIconTemplate && !contextMenu._submenuIconTemplate"
[class]="cx('submenuIcon')"
[pBind]="getPTOptions(processedItem, index, 'submenuIcon')"
[attr.aria-hidden]="true"
/>
<ng-template *ngTemplateOutlet="contextMenu.submenuIconTemplate || contextMenu._submenuIconTemplate; context: { class: 'p-contextmenu-submenu-icon' }" [attr.aria-hidden]="true"></ng-template>
</ng-container>
</a>
<a
*ngIf="getItemProp(processedItem, 'routerLink')"
[routerLink]="getItemProp(processedItem, 'routerLink')"
[attr.data-automationid]="getItemProp(processedItem, 'automationId')"
[attr.title]="getItemProp(processedItem, 'title')"
[attr.tabindex]="-1"
[queryParams]="getItemProp(processedItem, 'queryParams')"
[routerLinkActiveOptions]="getItemProp(processedItem, 'routerLinkActiveOptions') || { exact: false }"
[target]="getItemProp(processedItem, 'target')"
[class]="cn(cx('itemLink'), getItemProp(processedItem, 'linkClass'))"
[ngStyle]="getItemProp(processedItem, 'linkStyle')"
[fragment]="getItemProp(processedItem, 'fragment')"
[queryParamsHandling]="getItemProp(processedItem, 'queryParamsHandling')"
[preserveFragment]="getItemProp(processedItem, 'preserveFragment')"
[skipLocationChange]="getItemProp(processedItem, 'skipLocationChange')"
[replaceUrl]="getItemProp(processedItem, 'replaceUrl')"
[state]="getItemProp(processedItem, 'state')"
[pBind]="getPTOptions(processedItem, index, 'itemLink')"
pRipple
>
<span
*ngIf="getItemProp(processedItem, 'icon')"
[class]="cn(cx('itemIcon'), getItemProp(processedItem, 'icon'), getItemProp(processedItem, 'iconClass'))"
[ngStyle]="getItemProp(processedItem, 'iconStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemIcon')"
[attr.aria-hidden]="true"
[attr.tabindex]="-1"
>
</span>
<span
*ngIf="getItemProp(processedItem, 'escape'); else htmlLabel"
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
>
{{ getItemLabel(processedItem) }}
</span>
<ng-template #htmlLabel>
<span
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[innerHTML]="getItemLabel(processedItem)"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
></span>
</ng-template>
<p-badge *ngIf="getItemProp(processedItem, 'badge')" [class]="getItemProp(processedItem, 'badgeStyleClass')" [value]="getItemProp(processedItem, 'badge')" [unstyled]="unstyled()" />
<ng-container *ngIf="isItemGroup(processedItem)">
<svg
data-p-icon="angle-right"
*ngIf="!contextMenu.submenuIconTemplate && !contextMenu._submenuIconTemplate"
[class]="cx('submenuIcon')"
[pBind]="getPTOptions(processedItem, index, 'submenuIcon')"
[attr.aria-hidden]="true"
/>
<ng-template *ngTemplateOutlet="contextMenu.submenuIconTemplate || contextMenu._submenuIconTemplate; context: { class: 'p-contextmenu-submenu-icon' }" [attr.aria-hidden]="true"></ng-template>
</ng-container>
</a>
</ng-container>
<ng-container *ngIf="itemTemplate">
<ng-template *ngTemplateOutlet="itemTemplate; context: { $implicit: processedItem.item }"></ng-template>
</ng-container>
</div>
<p-contextmenu-sub
*ngIf="isItemVisible(processedItem) && isItemGroup(processedItem)"
[items]="processedItem.items"
[itemTemplate]="itemTemplate"
[menuId]="menuId"
[visible]="isItemActive(processedItem) && isItemGroup(processedItem)"
[activeItemPath]="activeItemPath"
[focusedItemId]="focusedItemId"
[level]="level + 1"
(itemClick)="itemClick.emit($event)"
(itemMouseEnter)="onItemMouseEnter($event)"
[pt]="pt()"
[motionOptions]="motionOptions"
[unstyled]="unstyled()"
/>
</li>
</ng-template>
</ul>
}
`, isInline: true, dependencies: [{ kind: "component", type: ContextMenuSub, selector: "p-contextMenuSub, p-contextmenu-sub", inputs: ["visible", "items", "itemTemplate", "root", "autoZIndex", "baseZIndex", "popup", "menuId", "ariaLabel", "ariaLabelledBy", "level", "focusedItemId", "activeItemPath", "motionOptions", "tabindex"], outputs: ["itemClick", "itemMouseEnter", "menuFocus", "menuBlur", "menuKeydown"] }, { kind: "ngmodule", type: CommonModule }, { kind: "directive", type: i1.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }, { kind: "directive", type: i1.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { kind: "directive", type: i1.NgTemplateOutlet, selector: "[ngTemplateOutlet]", inputs: ["ngTemplateOutletContext", "ngTemplateOutlet", "ngTemplateOutletInjector"] }, { kind: "directive", type: i1.NgStyle, selector: "[ngStyle]", inputs: ["ngStyle"] }, { kind: "ngmodule", type: RouterModule }, { kind: "directive", type: i2.RouterLink, selector: "[routerLink]", inputs: ["target", "queryParams", "fragment", "queryParamsHandling", "state", "info", "relativeTo", "preserveFragment", "skipLocationChange", "replaceUrl", "routerLink"] }, { kind: "directive", type: Ripple, selector: "[pRipple]" }, { kind: "ngmodule", type: TooltipModule }, { kind: "directive", type: i3.Tooltip, selector: "[pTooltip]", inputs: ["tooltipPosition", "tooltipEvent", "positionStyle", "tooltipStyleClass", "tooltipZIndex", "escape", "showDelay", "hideDelay", "life", "positionTop", "positionLeft", "autoHide", "fitContent", "hideOnEscape", "pTooltip", "tooltipDisabled", "tooltipOptions", "appendTo", "ptTooltip", "pTooltipPT", "pTooltipUnstyled"] }, { kind: "directive", type: i4.Bind, selector: "[pBind]", inputs: ["pBind"] }, { kind: "component", type: AngleRightIcon, selector: "[data-p-icon=\"angle-right\"]" }, { kind: "ngmodule", type: BadgeModule }, { kind: "component", type: i5.Badge, selector: "p-badge", inputs: ["styleClass", "badgeSize", "size", "severity", "value", "badgeDisabled"] }, { kind: "ngmodule", type: SharedModule }, { kind: "ngmodule", type: BindModule }, { kind: "ngmodule", type: MotionModule }, { kind: "directive", type: i6.MotionDirective, selector: "[pMotion]", inputs: ["pMotion", "pMotionName", "pMotionType", "pMotionSafe", "pMotionDisabled", "pMotionAppear", "pMotionEnter", "pMotionLeave", "pMotionDuration", "pMotionHideStrategy", "pMotionEnterFromClass", "pMotionEnterToClass", "pMotionEnterActiveClass", "pMotionLeaveFromClass", "pMotionLeaveToClass", "pMotionLeaveActiveClass", "pMotionOptions"], outputs: ["pMotionOnBeforeEnter", "pMotionOnEnter", "pMotionOnAfterEnter", "pMotionOnEnterCancelled", "pMotionOnBeforeLeave", "pMotionOnLeave", "pMotionOnAfterLeave", "pMotionOnLeaveCancelled"] }], encapsulation: i0.ViewEncapsulation.None });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.0.5", ngImport: i0, type: ContextMenuSub, decorators: [{
type: Component,
args: [{
selector: 'p-contextMenuSub, p-contextmenu-sub',
standalone: true,
imports: [CommonModule, RouterModule, Ripple, TooltipModule, AngleRightIcon, BadgeModule, SharedModule, BindModule, MotionModule],
template: `
@if (render()) {
<ul
#sublist
role="menu"
[class]="root ? cx('rootList') : cx('submenu')"
[pBind]="_ptm(root ? 'rootList' : 'submenu')"
[attr.id]="menuId + '_list'"
[tabindex]="tabindex"
[attr.aria-label]="ariaLabel"
[attr.aria-labelledBy]="ariaLabelledBy"
[attr.aria-activedescendant]="focusedItemId"
[attr.aria-orientation]="'vertical'"
(keydown)="menuKeydown.emit($event)"
(focus)="menuFocus.emit($event)"
(blur)="menuBlur.emit($event)"
[pMotion]="root ? true : visible"
[pMotionAppear]="true"
[pMotionName]="'p-anchored-overlay'"
[pMotionOptions]="motionOptions"
(pMotionOnBeforeEnter)="onBeforeEnter($event)"
(pMotionOnAfterLeave)="onAfterLeave()"
>
<ng-template ngFor let-processedItem [ngForOf]="items" let-index="index">
<li
*ngIf="isItemVisible(processedItem) && getItemProp(processedItem, 'separator')"
[attr.id]="getItemId(processedItem)"
[style]="getItemProp(processedItem, 'style')"
[class]="cn(cx('separator'), getItemProp(processedItem, 'styleClass'))"
role="separator"
[pBind]="_ptm('separator')"
></li>
<li
#listItem
*ngIf="isItemVisible(processedItem) && !getItemProp(processedItem, 'separator')"
role="menuitem"
[attr.id]="getItemId(processedItem)"
[attr.data-p-highlight]="isItemActive(processedItem)"
[attr.data-p-focused]="isItemFocused(processedItem)"
[attr.data-p-disabled]="isItemDisabled(processedItem)"
[attr.aria-label]="getItemLabel(processedItem)"
[attr.aria-disabled]="isItemDisabled(processedItem) || undefined"
[attr.aria-haspopup]="isItemGroup(processedItem) && !getItemProp(processedItem, 'to') ? 'menu' : undefined"
[attr.aria-expanded]="isItemGroup(processedItem) ? isItemActive(processedItem) : undefined"
[attr.aria-level]="level + 1"
[attr.aria-setsize]="getAriaSetSize()"
[attr.aria-posinset]="getAriaPosInset(index)"
[style]="getItemProp(processedItem, 'style')"
[class]="cn(cx('item', { instance: this, processedItem }), getItemProp(processedItem, 'styleClass'))"
[pBind]="getPTOptions(processedItem, index, 'item')"
pTooltip
[tooltipOptions]="getItemProp(processedItem, 'tooltipOptions')"
[pTooltipUnstyled]="unstyled()"
>
<div [class]="cx('itemContent')" [pBind]="getPTOptions(processedItem, index, 'itemContent')" (click)="onItemClick($event, processedItem)" (mouseenter)="onItemMouseEnter({ $event, processedItem })">
<ng-container *ngIf="!itemTemplate">
<a
*ngIf="!getItemProp(processedItem, 'routerLink')"
[attr.href]="getItemProp(processedItem, 'url')"
[attr.data-automationid]="getItemProp(processedItem, 'automationId')"
[attr.title]="getItemProp(processedItem, 'title')"
[target]="getItemProp(processedItem, 'target')"
[class]="cn(cx('itemLink'), getItemProp(processedItem, 'linkClass'))"
[ngStyle]="getItemProp(processedItem, 'linkStyle')"
[attr.tabindex]="-1"
[pBind]="getPTOptions(processedItem, index, 'itemLink')"
pRipple
>
<span
*ngIf="getItemProp(processedItem, 'icon')"
[class]="cn(cx('itemIcon'), getItemProp(processedItem, 'icon'), getItemProp(processedItem, 'iconClass'))"
[ngStyle]="getItemProp(processedItem, 'iconStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemIcon')"
[attr.aria-hidden]="true"
[attr.tabindex]="-1"
>
</span>
<span
*ngIf="getItemProp(processedItem, 'escape'); else htmlLabel"
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
>
{{ getItemLabel(processedItem) }}
</span>
<ng-template #htmlLabel>
<span
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[innerHTML]="getItemLabel(processedItem)"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
></span>
</ng-template>
<p-badge *ngIf="getItemProp(processedItem, 'badge')" [class]="getItemProp(processedItem, 'badgeStyleClass')" [value]="getItemProp(processedItem, 'badge')" [unstyled]="unstyled()" />
<ng-container *ngIf="isItemGroup(processedItem)">
<svg
data-p-icon="angle-right"
*ngIf="!contextMenu.submenuIconTemplate && !contextMenu._submenuIconTemplate"
[class]="cx('submenuIcon')"
[pBind]="getPTOptions(processedItem, index, 'submenuIcon')"
[attr.aria-hidden]="true"
/>
<ng-template *ngTemplateOutlet="contextMenu.submenuIconTemplate || contextMenu._submenuIconTemplate; context: { class: 'p-contextmenu-submenu-icon' }" [attr.aria-hidden]="true"></ng-template>
</ng-container>
</a>
<a
*ngIf="getItemProp(processedItem, 'routerLink')"
[routerLink]="getItemProp(processedItem, 'routerLink')"
[attr.data-automationid]="getItemProp(processedItem, 'automationId')"
[attr.title]="getItemProp(processedItem, 'title')"
[attr.tabindex]="-1"
[queryParams]="getItemProp(processedItem, 'queryParams')"
[routerLinkActiveOptions]="getItemProp(processedItem, 'routerLinkActiveOptions') || { exact: false }"
[target]="getItemProp(processedItem, 'target')"
[class]="cn(cx('itemLink'), getItemProp(processedItem, 'linkClass'))"
[ngStyle]="getItemProp(processedItem, 'linkStyle')"
[fragment]="getItemProp(processedItem, 'fragment')"
[queryParamsHandling]="getItemProp(processedItem, 'queryParamsHandling')"
[preserveFragment]="getItemProp(processedItem, 'preserveFragment')"
[skipLocationChange]="getItemProp(processedItem, 'skipLocationChange')"
[replaceUrl]="getItemProp(processedItem, 'replaceUrl')"
[state]="getItemProp(processedItem, 'state')"
[pBind]="getPTOptions(processedItem, index, 'itemLink')"
pRipple
>
<span
*ngIf="getItemProp(processedItem, 'icon')"
[class]="cn(cx('itemIcon'), getItemProp(processedItem, 'icon'), getItemProp(processedItem, 'iconClass'))"
[ngStyle]="getItemProp(processedItem, 'iconStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemIcon')"
[attr.aria-hidden]="true"
[attr.tabindex]="-1"
>
</span>
<span
*ngIf="getItemProp(processedItem, 'escape'); else htmlLabel"
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
>
{{ getItemLabel(processedItem) }}
</span>
<ng-template #htmlLabel>
<span
[class]="cn(cx('itemLabel'), getItemProp(processedItem, 'labelClass'))"
[ngStyle]="getItemProp(processedItem, 'labelStyle')"
[innerHTML]="getItemLabel(processedItem)"
[pBind]="getPTOptions(processedItem, index, 'itemLabel')"
></span>
</ng-template>
<p-badge *ngIf="getItemProp(processedItem, 'badge')" [class]="getItemProp(processedItem, 'badgeStyleClass')" [value]="getItemProp(processedItem, 'badge')" [unstyled]="unstyled()" />
<ng-container *ngIf="isItemGroup(processedItem)">
<svg
data-p-icon="angle-right"
*ngIf="!contextMenu.submenuIconTemplate && !contextMenu._submenuIconTemplate"
[class]="cx('submenuIcon')"
[pBind]="getPTOptions(processedItem, index, 'submenuIcon')"
[attr.aria-hidden]="true"
/>
<ng-template *ngTemplateOutlet="contextMenu.submenuIconTemplate || contextMenu._submenuIconTemplate; context: { class: 'p-contextmenu-submenu-icon' }" [attr.aria-hidden]="true"></ng-template>
</ng-container>
</a>
</ng-container>
<ng-container *ngIf="itemTemplate">
<ng-template *ngTemplateOutlet="itemTemplate; context: { $implicit: processedItem.item }"></ng-template>
</ng-container>
</div>
<p-contextmenu-sub
*ngIf="isItemVisible(processedItem) && isItemGroup(processedItem)"
[items]="processedItem.items"
[itemTemplate]="itemTemplate"
[menuId]="menuId"
[visible]="isItemActive(processedItem) && isItemGroup(processedItem)"
[activeItemPath]="activeItemPath"
[focusedItemId]="focusedItemId"
[level]="level + 1"
(itemClick)="itemClick.emit($event)"
(itemMouseEnter)="onItemMouseEnter($event)"
[pt]="pt()"
[motionOptions]="motionOptions"
[unstyled]="unstyled()"
/>
</li>
</ng-template>
</ul>
}
`,
encapsulation: ViewEncapsulation.None,
providers: [ContextMenuStyle, { provide: CONTEXTMENUSUB_INSTANCE, useExisting: ContextMenuSub }, { provide: PARENT_INSTANCE, useExisting: ContextMenuSub }]
}]
}], ctorParameters: () => [{ type: i0.ElementRef }, { type: i0.Renderer2 }, { type: ContextMenu, decorators: [{
type: Inject,
args: [forwardRef(() => ContextMenu)]
}] }], propDecorators: { visible: [{
type: Input
}], items: [{
type: Input
}], itemTemplate: [{
type: Input
}], root: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], autoZIndex: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], baseZIndex: [{
type: Input,
args: [{ transform: numberAttribute }]
}], popup: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], menuId: [{
type: Input
}], ariaLabel: [{
type: Input
}], ariaLabelledBy: [{
type: Input
}], level: [{
type: Input,
args: [{ transform: numberAttribute }]
}], focusedItemId: [{
type: Input
}], activeItemPath: [{
type: Input
}], motionOptions: [{
type: Input
}], tabindex: [{
type: Input,
args: [{ transform: numberAttribute }]
}], itemClick: [{
type: Output
}], itemMouseEnter: [{
type: Output
}], menuFocus: [{
type: Output
}], menuBlur: [{
type: Output
}], menuKeydown: [{
type: Output
}], sublistViewChild: [{
type: ViewChild,
args: ['sublist']
}] } });
/**
* ContextMenu displays an overlay menu on right click of its target. Note that components like Table has special integration with ContextMenu.
* @group Components
*/
class ContextMenu extends BaseComponent {
overlayService;
/**
* An array of menuitems.
* @group Props
*/
set model(value) {
this._model = value;
this._processedItems = this.createProcessedItems(this._model || []);
}
get model() {
return this._model;
}
/**
* Event for which the menu must be displayed.
* @group Props
*/
triggerEvent = 'contextmenu';
/**
* Local template variable name of the element to attach the context menu.
* @group Props
*/
target;
/**
* Attaches the menu to document instead of a particular item.
* @group Props
*/
global;
/**
* Inline style of the component.
* @group Props
*/
style;
/**
* Style class of the component.
* @group Props
*/
styleClass;
/**
* Whether to automatically manage layering.
* @group Props
*/
autoZIndex = true;
/**
* Base zIndex value to use in layering.
* @group Props
*/
baseZIndex = 0;
/**
* Current id state as a string.
* @group Props
*/
id;
/**
* The breakpoint to define the maximum width boundary.
* @group Props
*/
breakpoint = '960px';
/**
* Defines a string value that labels an interactive element.
* @group Props
*/
ariaLabel;
/**
* Identifier of the underlying input element.
* @group Props
*/
ariaLabelledBy;
/**
* Press delay in touch devices as miliseconds.
* @group Props
*/
pressDelay = 500;
/**
* 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).
* @defaultValue 'self'
* @group Props
*/
appendTo = input(undefined, ...(ngDevMode ? [{ debugName: "appendTo" }] : []));
/**
* The motion options.
* @group Props
*/
motionOptions = input(undefined, ...(ngDevMode ? [{ debugName: "motionOptions" }] : []));
computedMotionOptions = computed(() => {
return {
...this.ptm('motion'),
...this.motionOptions()
};
}, ...(ngDevMode ? [{ debugName: "computedMotionOptions" }] : []));
/**
* Callback to invoke when overlay menu is shown.
* @group Emits
*/
onShow = new EventEmitter();
/**
* Callback to invoke when overlay menu is hidden.
* @group Emits
*/
onHide = new EventEmitter();
rootmenu;
container;
handleSubmenuAfterLeave = null;
outsideClickListener;
resizeListener;
triggerEventListener;
documentClickListener;
documentTriggerListener;
touchEndListener;
pageX;
pageY;
visible = signal(false, ...(ngDevMode ? [{ debugName: "visible" }] : []));
render = signal(false, ...(ngDevMode ? [{ debugName: "render" }] : []));
focused = false;
activeItemPath = signal([], ...(ngDevMode ? [{ debugName: "activeItemPath" }] : []));
focusedItemInfo = signal({ index: -1, level: 0, parentKey: '', item: null }, ...(ngDevMode ? [{ debugName: "focusedItemInfo" }] : []));
submenuVisible = signal(false, ...(ngDevMode ? [{ debugName: "submenuVisible" }] : []));
$appendTo = computed(() => this.appendTo() || this.config.overlayAppendTo(), ...(ngDevMode ? [{ debugName: "$appendTo" }] : []));
searchValue = '';
searchTimeout;
_processedItems;
_model;
pressTimer;
hideCallback;
matchMediaListener;
query;
queryMatches = signal(false, ...(ngDevMode ? [{ debugName: "queryMatches" }] : []));
_componentStyle = inject(ContextMenuStyle);
get visibleItems() {
const processedItem = this.activeItemPath().find((p) => p.key === this.focusedItemInfo().parentKey);
return processedItem ? processedItem.items : this.processedItems;
}
get processedItems() {
if (!this._processedItems || !this._processedItems.length) {
this._processedItems = this.createProcessedItems(this.model || []);
}
return this._processedItems;
}
get focusedItemId() {
const focusedItem = this.focusedItemInfo();
return focusedItem.item && focusedItem.item?.id ? focusedItem.item.id : focusedItem.index !== -1 ? `${this.id}${isNotEmpty(focusedItem.parentKey) ? '_' + focusedItem.parentKey : ''}_${focusedItem.index}` : null;
}
constructor(overlayService) {
super();
this.overlayService = overlayService;
effect(() => {
const path = this.activeItemPath();
if (isNotEmpty(path)) {
this.bindGlobalListeners();
}
else if (!this.visible()) {
this.unbindGlobalListeners();
}
});
}
onInit() {
this.id = this.id || uuid('pn_id_');
this.bindMatchMediaListener();
this.bindTriggerEventListener();
}
isMobile() {
return isIOS() || isAndroid();
}
bindTriggerEventListener() {
if (isPlatformBrowser(this.platformId)) {
if (!this.triggerEventListener) {
if (!this.isMobile()) {
if (this.global) {
this.triggerEventListener = this.renderer.listen(this.document, this.triggerEvent, (event) => {
this.show(event);
});
}
else if (this.target) {
this.triggerEventListener = this.renderer.listen(this.target, this.triggerEvent, (event) => {
this.show(event);
});
}
}
else {
if (this.global) {
this.triggerEventListener = this.renderer.listen(this.document, 'touchstart', this.onTouchStart.bind(this));
this.touchEndListener = this.renderer.listen(this.document, 'touchend', this.onTouchEnd.bind(this));
}
else if (this.target) {
this.triggerEventListener = this.renderer.listen(this.target, 'touchstart', this.onTouchStart.bind(this));
this.touchEndListener = this.renderer.listen(this.target, 'touchend', this.onTouchEnd.bind(this));
}
}
}
}
}
bindGlo