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" />

Vertical #

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


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

Template #

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


<p-megaMenu [model]="items" [style]="{ 'border-radius': '3rem', display: 'flex' }" styleClass="p-3 surface-0">
    <ng-template pTemplate="start">
        <svg width="33" height="35" viewBox="0 0 33 35" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-2rem">
            <path d="..." fill="var(--primary-color)" />
            <mask id="mask0_1_36" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="31" height="33">
                <path d="..." fill="var(--primary-color-text)" />
            </mask>
            <g mask="url(#mask0_1_36)">
                <path fill-rule="evenodd" clip-rule="evenodd" d="..." fill="var(--primary-color)" />
            </g>
            <path d="..." fill="var(--primary-color-text)" />
            <path d="..." fill="var(--primary-color-text)" />
            <path
                fill-rule="evenodd"
                clip-rule="evenodd"
                d="..."
                fill="var(--primary-color-text)"
            />
            <path d="..." fill="var(--primary-color-text)" />
            <path d="..." fill="var(--primary-color-text)" />
            <path
                fill-rule="evenodd"
                clip-rule="evenodd"
                d="..."
                fill="var(--primary-color-text)"
            />
            <path d="..." fill="var(--primary-color-text)" />
            <path d="..." fill="var(--primary-color-text)" />
            <path d="..." fill="var(--primary-color-text)" />
            <path d="..." fill="var(--primary-color-text)" />
        </svg>
    </ng-template>
    <ng-template pTemplate="item" let-item>
        <a *ngIf="item.root" pRipple class="flex align-items-center cursor-pointer px-3 py-2 overflow-hidden relative font-semibold text-lg uppercase" style="border-radius: 2rem">
            <i [ngClass]="item.icon"></i>
            <span class="ml-2">{{ item.label }}</span>
        </a>
        <a *ngIf="!item.root && !item.image" class="flex align-items-center p-3 cursor-pointer mb-2 gap-2">
            <span class="inline-flex align-items-center justify-content-center border-circle bg-primary w-3rem h-3rem">
                <i [ngClass]="item.icon + ' text-lg'"></i>
            </span>
            <span class="inline-flex flex-column gap-1">
                <span class="font-medium text-lg text-900">{{ item.label }}</span>
                <span class="white-space-nowrap">{{ item.subtext }}</span>
            </span>
        </a>
        <div *ngIf="item.image" class="flex flex-column align-items-start gap-3">
            <img [src]="item.image" alt="megamenu-demo" class="w-full" />
            <span>{{ item.subtext }}</span>
            <p-button [label]="item.label" [outlined]="true"></p-button>
        </div>
    </ng-template>
    <ng-template pTemplate="end">
        <p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" shape="circle" />
    </ng-template>
</p-megaMenu>

Command #

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


{
    label: 'Log out',
    icon: 'pi pi-signout',
    command: () => {
        // Callback to run
    }
}

Router #

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


<p-megaMenu [model]="items">
    <ng-template pTemplate="item" let-item>
        <ng-container *ngIf="item.route; else elseBlock">
            <a [routerLink]="item.route" class="p-menuitem-link">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
        </ng-container>
        <ng-template #elseBlock>
            <a [href]="item.url" class="p-menuitem-link">
                <span [class]="item.icon"></span>
                <span class="ml-2">{{ item.label }}</span>
            </a>
        </ng-template>
    </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 #

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.

MegaMenu #

MegaMenu is navigation component that displays submenus together.

Properties #

Defines the input properties of the component.

name	type	default	description
model	MegaMenuItem[]	null	An array of menuitems.
style	Object	null	Inline style of the element.
styleClass	string	null	Class of the element.
orientation	string	horizontal	Defines the orientation.
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.

Templates #

Defines the templates used by the component.

name	parameters	description
item	context : { $implicit: MenuItem, // Item instance. }	Custom item template.
start		Custom template of start.
submenuicon		Custom template of submenuicon.
end		Custom template of end.

Interfaces #

Defines the custom interfaces used by the module.

MegaMenuItem #

MegaMenuItem API provides the following properties.

name	type	description
label	string	Text of the item.
icon	string	Icon of the item.
command	Function	Callback to execute when item is clicked.
url	string	External link to navigate when item is clicked.
items	MenuItem[][]	An array of children menuitems.
expanded	boolean	Specifies whether the mega menu item is expanded.
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.
routerLinkActiveOptions	any	Configuration for active router link.
separator	boolean	Defines the item as a separator.
badge	string	Value of the badge.
badgeStyleClass	string	Style class of the badge.
style	any	Inline style of the menuitem.
styleClass	string	Style class of the menuitem.
iconStyle	any	Inline style of the item's icon.
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.
state	Object	Developer-defined state that can be passed to any navigation.