PanelMenu

PanelMenu is a hybrid of Accordion and Tree components.

Import #


import { PanelMenuModule } from 'primeng/panelmenu';

Basic #

PanelMenu requires a collection of menuitems as its model.

Files

Cloud

Devices


<p-panelmenu [model]="items" styleClass="w-full md:w-20rem" />

Multiple #

Only one single root menuitem can be active by default, enable multiple property to be able to open more than one items.

Files

Cloud

Devices


<p-panelmenu [model]="items" [style]="{'width':'300px'}" [multiple]="true" />

Controlled #

Menu items can be controlled programmatically.

Users

Tasks

Calendar


<p-button label="Toggle All" [text]="true" (onClick)="toggleAll()" />
<p-panelmenu [model]="items" styleClass="w-full md:w-80" />

Template #

PanelMenu requires a collection of menuitems as its model.

Mail

Reports⌘+R

Profile⌘+W


<p-panelmenu [model]="items" styleClass="w-full md:w-80">
    <ng-template #item let-item>
        <a pRipple class="flex items-center px-4 py-2 cursor-pointer group">
            <i [class]="item.icon + ' text-primary group-hover:text-inherit'"></i>
            <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>
        </a>
    </ng-template>
</p-panelmenu>

Command #

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

Files

Sync

Sign Out


<p-toast />
<p-panelmenu [model]="items" styleClass="w-full md:w-80" />

Router #

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

Router

Programmatic

External


<p-panelmenu [model]="items" styleClass="w-full md:w-80">
    <ng-template #item let-item>
        <ng-container *ngIf="item.route; else urlRef">
            <a [routerLink]="item.route" class="flex align-items-center
                cursor-pointer text-color px-3 py-2">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
        </ng-container>
        <ng-template #urlRef>
            <a *ngIf="item.url; else noLink" [href]="item.url" class="flex align-items-center
                cursor-pointer text-color px-3 py-2">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
            <ng-template #noLink>
                <span class="flex items-center cursor-pointer text-surface-700 dark:text-surface-0 px-4 py-2">
                    <span [class]="item.icon"></span>
                    <span class="ml-2">{{ item.label }}</span>
                    <i *ngIf="item.items" class="pi pi-angle-down text-primary ml-auto"></i>
                </span>
            </ng-template>
        </ng-template>
    </ng-template>
</p-panelmenu>

Accessibility #

Screen Reader

Accordion header elements have a button role, an aria-label defined using the label property of the menuitem model and aria-controls to define the id of the content section along with aria-expanded for the visibility state.

The content of an accordion panel uses region role, defines an id that matches the aria-controls of the header and aria-labelledby referring to the id of the header.

The tree elements has a tree as the role and each menu item has a treeitem role along with aria-label, aria-selected and aria-expanded attributes. The container element of a treenode has the group role. The aria-setsize, aria-posinset and aria-level attributes are calculated implicitly and added to each treeitem.

Header Keyboard Support

Key	Function
tab	Adds focus to the first header when focus moves in to the component, if there is already a focused tab header then moves the focus out of the component based on the page tab sequence.
enter	Toggles the visibility of the content.
space	Toggles the visibility of the content.
down arrow	If panel is collapsed then moves focus to the next header, otherwise first treenode of the panel receives the focus.
up arrow	If previous panel is collapsed then moves focus to the previous header, otherwise last treenode of the previous panel receives the focus.
home	Moves focus to the first header.
end	Moves focus to the last header.

Tree Keyboard Support

Key	Function
tab	Moves focus to the next focusable element in the page tab order.
shift + tab	Moves focus to the previous focusable element in the page tab order.
enter	Activates the focused treenode.
space	Activates the focused treenode.
down arrow	Moves focus to the next treenode.
up arrow	Moves focus to the previous treenode.
right arrow	If node is closed, opens the node otherwise moves focus to the first child node.
left arrow	If node is open, closes the node otherwise moves focus to the parent node.

name	type	default	description
model	MenuItem[]	null	An array of menuitems.
style	Object	null	Inline style of the component.
styleClass	string	null	Style class of the component.
multiple	boolean	false	Whether multiple tabs can be activated at the same time or not.
transitionOptions	string	400ms cubic-bezier(0.86, 0, 0.07, 1)	Transition options of the animation.
id	string	null	Current id state as a string.
tabindex	number	0	Index of the element in tabbing order.

name	parameters	description
item	context : { $implicit: MenuItem, // Item instance. }	Custom item template.
submenuicon		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.

PanelMenu

Import #

Basic #

Multiple #

Controlled #

Template #

Command #

Router #

Accessibility #

Screen Reader

Header Keyboard Support

Tree Keyboard Support

PanelMenu API

PanelMenu #

Properties #

Methods #

Templates #

Interfaces #

MenuItem #