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.


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

Multiple #

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


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

Style #

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

Name	Element
p-panelmenu	Container element.
p-panelmenu-header	Accordion header of root submenu.
p-panelmenu-content	Accordion content of root submenu.
p-menu-list	List element.
p-menuitem	Menuitem element.
p-menuitem-text	Label of a menuitem.
p-menuitem-icon	Icon of a menuitem.
p-panelmenu-icon	Arrow icon of an accordion header.

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.

PanelMenu API

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

PanelMenu #

PanelMenu is a hybrid of Accordion and Tree components.

Properties #

Defines the input properties of the component.

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.

Methods #

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

name	parameters	description
collapseAll	null	Collapses open panels.

Templates #

Defines the templates used by the component.

name	parameters	description
submenuicon	null	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.