TieredMenu

TieredMenu displays submenus in nested overlays.

Import #


import { TieredMenuModule } from 'primeng/tieredmenu';

Basic #

TieredMenu requires a collection of menuitems as its model.


<p-tieredMenu [model]="items" />

Popup #

Popup mode is enabled by adding popup property and calling toggle method with an event of the target.


<p-button label="Toggle" (onClick)="menu.toggle($event)" />
<p-tieredMenu #menu [model]="items" [popup]="true" />

Template #

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


<p-tieredMenu [model]="items">
    <ng-template pTemplate="item" let-item let-hasSubmenu="hasSubmenu">
    <a pRipple class="flex align-items-center p-menuitem-link">
    <span [class]="item.icon" class="p-menuitem-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-1 surface-border border-round surface-100 text-xs p-1">
                {{ item.shortcut }}
            </span>
            <i *ngIf="hasSubmenu" class="pi pi-angle-right ml-auto text-primary"></i>
        </a>
    </ng-template>
</p-tieredMenu>

Command #

The command property defines the callback to run when an item is activated by click or a key event.


<p-toast/>
<p-tieredMenu [model]="items" />

Router #

Items with navigation are defined with templating to be able to use a router link component, an external link or programmatic navigation.


<p-tieredMenu [model]="items">
        <ng-template pTemplate="item" let-item let-hasSubmenu="hasSubmenu">
            <ng-container *ngIf="item.route; else withoutRoute">
                <a [routerLink]="item.route" [href]="item.href" class="p-menuitem-link">
                    <span class="item.icon"></span>
                    <span class="ml-2">{{ item.label }}</span>
                </a>
            </ng-container>
            <ng-template #withoutRoute>
                <ng-container *ngIf="item.url; else withoutUrl">
                    <a [href]="item.url" [target]="item.target" class="p-menuitem-link">
                        <span [class]="item.icon"></span>
                        <span class="ml-2">{{ item.label }}</span>
                        <span *ngIf="hasSubmenu" class="pi pi-angle-right ml-auto"></span>
                    </a>
                </ng-container>
                <ng-template #withoutUrl>
                    <a class="p-menuitem-link">
                        <span [class]="item.icon"></span>
                        <span class="ml-2">{{ item.label }}</span>
                        <span *ngIf="hasSubmenu" class="pi pi-angle-right ml-auto"></span>
                    </a>
                </ng-template>
            </ng-template>
        </ng-template>
</p-tieredMenu>

Style #

Following is the list of structural style classes, for theming classes visit theming page.

Name	Element
p-tieredmenu	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

TieredMenu 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 TieredMenu 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.

In popup mode, the component implicitly manages the aria-expanded, aria-haspopup and aria-controls attributes of the target element to define the relation between the target and the popup.

Keyboard Support

Key	Function
tab	Add focus to the first item if focus moves in to the menu. If the focus is already within the menu, focus moves to the next focusable item in the page tab sequence.
shift + tab	Add focus to the last item if focus moves in to the menu. If the focus is already within the menu, focus moves to the previous focusable item in the page tab 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	If focus is inside a popup submenu, closes the submenu and moves focus to the root item of the closed submenu.
down arrow	Moves focus to the next menuitem within the submenu.
up arrow	Moves focus to the previous 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.

TieredMenu API

API defines helper props, events and others for the PrimeNG TieredMenu module.

TieredMenu #

TieredMenu displays submenus in nested overlays.

Properties #

Defines the input properties of the component.

name	type	default	description
model	MenuItem[]	null	An array of menuitems.
popup	boolean	false	Defines if menu would displayed as a popup.
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.
autoDisplay	boolean	true	Whether to show a root submenu on mouse over.
showTransitionOptions	string	.12s cubic-bezier(0, 0, 0.2, 1)	Transition options of the show animation.
hideTransitionOptions	string	.1s linear	Transition options of the hide animation.
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.
disabled	boolean	false	When present, it specifies that the component should be disabled.
tabindex	number	0	Index of the element in tabbing order.

Emitters #

Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.

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

Methods #

Defines methods that can be accessed by the component's reference.

name	parameters	description
hide	event : any isFocus : boolean	Hides the popup menu.
toggle	event : any	Toggles the visibility of the popup menu.
show	event : any isFocus : any	Displays the popup menu.

Templates #

Defines the templates used by the component.

name	parameters	description
item	context : { $implicit: any, // Item instance. hasSubmenu: boolean, // Submenu control of the item. }	Custom template of item.
submenuicon		Custom template of submenuicon.

Interfaces #

Defines the custom interfaces used by the module.

MenuItem #

MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.

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.