MegaMenu

MegaMenu is navigation component that displays submenus together.

Import #


import { MegaMenuModule } from 'primeng/megamenu';

Basic #

MegaMenu requires a collection of menuitems as its model.



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

Vertical #

Layout of the MegaMenu is changed with the orientation property that accepts horizontal and vertical as options.



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

Template #

Custom content can be placed between p-megaMenu tags. Megamenu should be horizontal for custom content.



<p-megaMenu [model]="items" styleClass="flex">
    <ng-template pTemplate="start">
        <img src="https://primefaces.org/cdn/primeng/images/primeng.svg" height="40" class="mr-2" />
    </ng-template>
    <ng-template pTemplate="end">
        <input type="text" pInputText placeholder="Search" />
    </ng-template>
</p-megaMenu>

Style #

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

Name	Element
p-megamenu	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 guide documents the specification of this component based on WCAG guidelines, the implementation is in progress.

Accessibility #

Screen Reader

MegaMenu component uses the menubar role along with aria-orientation and the value to describe the component 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 MegaMenu uses the menu role with an aria-labelledby defined as the id of the submenu root menuitem label. In addition, root 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	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	If focus is on a root element, open a submenu and moves focus to the first element in the submenu otherwise moves focus to the next menuitem within the submenu.
up arrow	If focus is on a root element, opens a submenu and moves focus to the last element in the submenu otherwise moves focus to the previous menuitem within the submenu.
right arrow	If focus is on a root element, moves focus to the next menuitem. If the focus in inside a submenu, moves focus to the first menuitem of the next menu group.
left arrow	If focus is on a root element, moves focus to the previous menuitem. If the focus in inside a submenu, moves focus to the first menuitem of the previous menu group.
home	Moves focus to the first menuitem within the submenu.
end	Moves focus to the last menuitem within the submenu.

MegaMenu API

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

Properties #

Name	Type	Default	Description
model	array	null	An array of menuitems.
orientation	string	horizontal	Defines the orientation, valid values are horizontal and vertical.
style	string	null	Inline style of the component.
styleClass	string	null	Style class of the component.

Events #

Name	Parameters	Description
onShow	event: Event object	Callback to invoke when overlay menu is shown.
onHide	event: Event object	Callback to invoke when overlay menu is hidden.

Templates #

Name	Parameters
start	-
end	-
submenuicon	-

MegaMenuItem API #

MegaMenuItem API provides the following properties.

Name	Type	Default	Description
id	string	null	Identifier of the element.
label	string	null	Text of the item.
icon	string	null	Icon of the item.
iconStyle	object	null	Inline style of the item's icon.
command	function	null	Callback to execute when item is clicked.
url	string	null	External link to navigate when item is clicked.
routerLink	array	null	RouterLink definition for internal navigation.
routerLinkActiveOptions	object	null	Configuration for active router link.
queryParams	object	null	Query parameters for internal navigation via routerLink.
fragment	string	null	Sets the hash fragment for the URL.
queryParamsHandling	QueryParamsHandling	null	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	false	When true, preserves the URL fragment for the next navigation.
skipLocationChange	boolean	null	When true, navigates without pushing a new state into history.
replaceUrl	boolean	null	When true, navigates while replacing the current state in history.
state	object	null	Developer-defined state that can be passed to any navigation.
items	array	null	An array of children menuitems.
disabled	boolean	false	When set as true, disables the menuitem.
visible	boolean	true	Whether the dom element of menuitem is created or not.
target	string	null	Specifies where to open the linked document.
separator	boolean	false	Defines the item as a separator.
style	object	null	Inline style of the menuitem.
styleClass	string	null	Style class of the menuitem.
badge	string	null	Value of the badge.
badgeStyleClass	string	null	Style class of the badge.
title	string	null	Tooltip text of the item.
automationId	any	null	Value of HTML data-* attribute.
tabindex	string	0	Specifies tab order of the item.