Menubar
Menubar is a horizontal menu component.
Import #
import { MenubarModule } from 'primeng/menubar';
Basic #
Menubar requires nested menuitems as its model.
<p-menubar [model]="items" />
Template #
Custom content can be placed inside the menubar using the start and end templates.
<p-menubar [model]="items">
<ng-template #start>
<svg width="33" height="35" viewBox="0 0 33 35" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="..." fill="var(--primary-color)" />
</svg>
</ng-template>
<ng-template #item let-item let-root="root">
<a pRipple class="flex items-center p-menubar-item-link">
<span>{{ item.label }}</span>
<p-badge *ngIf="item.badge" [ngClass]="{ 'ml-auto': !root, 'ml-2': root }" [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>
<i *ngIf="item.items" [ngClass]="['ml-auto pi', root ? 'pi-angle-down' : 'pi-angle-right']"></i>
</a>
</ng-template>
<ng-template #end>
<div class="flex items-center gap-2">
<input type="text" pInputText placeholder="Search" class="w-36" />
<p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" shape="circle" />
</div>
</ng-template>
</p-menubar>
Command #
The command property defines the callback to run when an item is activated by click or a key event.
<p-toast />
<p-menubar [model]="items" />
Router #
Items with navigation are defined with templating to be able to use a routerLink directive, an external link or programmatic navigation.
<p-menubar [model]="items">
<ng-template #item let-item>
<ng-container *ngIf="item.route; else urlRef">
<a [routerLink]="item.route" class="p-menubar-item-link">
<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="p-menubar-item-link">
<span [class]="item.icon"></span>
<span class="ml-2">{{ item.label }}</span>
</a>
</ng-template>
<ng-template #noLink>
<div class="p-menubar-item-link">
<span [class]="item.icon"></span>
<span class="ml-2">{{ item.label }}</span>
<span class="pi pi-fw pi-angle-down ml-2"></span>
</div>
</ng-template>
</ng-template>
</p-menubar>
Accessibility #
Screen Reader
Menubar component uses the menubar role 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 MenuBar 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 mobile viewports, a menu icon appears with a button role along with aria-haspopup, aria-expanded and aria-controls to manage the relation between the overlay menubar and the button. The value to describe the button can be defined aria-label or aria-labelledby specified using buttonProps, by default navigation key of the aria property from the locale API as the aria-label.
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 otherwise opens a submenu if there is one available and moves focus to the first item. |
| left arrow | If focus is on a root element, moves focus to the previous menuitem otherwise 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. |