TabMenu

TabMenu is a navigation component that displays items as tab headers. Example below uses nested routes with TabMenu.

Import #


import { TabMenuModule } from 'primeng/tabmenu';

Basic #

TabMenu requires a collection of menuitems as its model.


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

Controlled #

For controlled mode, use activeItem property along with activeItemChange event are needed to manage the active item.


<div class="flex mb-2 gap-2 justify-content-end">
    <p-button 
        (onClick)="activeItem = items[0]" 
        [rounded]="true" 
        label="1" 
        styleClass="w-2rem h-2rem p-0" 
        [outlined]="activeItem !== items[0]" />
    <p-button 
        (onClick)="activeItem = items[1]" 
        [rounded]="true" 
        label="2" 
        styleClass="w-2rem h-2rem p-0" 
        [outlined]="activeItem !== items[1]" />
    <p-button 
        (onClick)="activeItem = items[2]" 
        [rounded]="true" 
        label="3" 
        styleClass="w-2rem h-2rem p-0" 
        [outlined]="activeItem !== items[2]" />
</div>
<p-tabMenu 
    [model]="items" 
    [activeItem]="activeItem" 
    (activeItemChange)="onActiveItemChange($event)" />

Template #

TabMenu supports templating via the item template which gets the menuitem instance and the index.


<p-tabMenu [model]="items" [activeItem]="activeItem">
    <ng-template pTemplate="item" let-item>
        <a pRipple class="flex align-items-center gap-2 p-menuitem-link">
            <img 
                [alt]="item.name" 
                [src]="'https://primefaces.org/cdn/primeng/images/demo/avatar/' + item.image" 
                style="width: 32px" />
            <span class="font-bold">
                {{ item.name }}
            </span>
        </a>
    </ng-template>
</p-tabMenu>

Command #

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


<p-toast />
<p-tabMenu [model]="items" />

Router #

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


<p-tabMenu [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-tabMenu>

Style #

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

Name	Element
p-tabmenu	Container element.
p-tabmenu-nav	List element of headers.
p-tabmenuitem	Menuitem element.
p-menuitem-link	Link inside a menuitem.
p-menuitem-text	Label of a menuitem.
p-menuitem-icon	Icon of a menuitem.

Accessibility #

Screen Reader

TabMenu 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.

Keyboard Support

Key	Function
tab	Adds focus to the active tab header when focus moves in to the component, if there is already a focused tab header moves the focus out of the component based on the page tab sequence.
enter	Activates the focused tab header.
space	Activates the focused tab header.
right arrow	Moves focus to the next header.
left arrow	Moves focus to the previous header.
home	Moves focus to the first header.
end	Moves focus to the last header.

TabMenu API

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

TabMenu #

TabMenu is a navigation component that displays items as tab headers.

Properties #

Defines the input properties of the component.

name	type	default	description
model	MenuItem[]	null	An array of menuitems.
activeItem	MenuItem	null	Defines the default active menuitem
scrollable	boolean	false	When enabled displays buttons at each side of the tab headers to scroll the tab list.
style	Object	null	Inline style of the element.
styleClass	string	null	Class of the element.
ariaLabel	string	null	Defines a string value that labels an interactive element.
ariaLabelledBy	string	null	Identifier of the underlying input element.

Emitters #

Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.

name	parameters	description
activeItemChange	value : MenuItem	Event fired when a tab is selected.

Templates #

Defines the templates used by the component.

name	parameters	description
item	context : { $implicit: any, // Item instance. index: number, // Item index. }	Custom template of item.
nexticon		Custom template of nexticon.
previousicon		Custom template of previousicon.

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.