TabViewTabView is a container component to group content with tabs.

Documentation

Import

import {TabViewModule} from 'primeng/tabview';
 

Getting Started

Tabview element consists of one or more p-tabPanel elements. Header of the tab is defined using header attribute.

<p-tabView>
    <p-tabPanel header="Header 1">
       Content 1
    </p-tabPanel>
    <p-tabPanel header="Header 2">
        Content 2
    </p-tabPanel>
    <p-tabPanel header="Header 3">
        Content 3
    </p-tabPanel>
</p-tabView>
 

Dynamic Tabs

p-tabPanel components can be generated dynamically using ngFor, note that in this case due to an Angular issue selected property must be enabled manually.

<p-tabView>
    <p-tabPanel [header]="item.header" *ngFor="let item of items; let i = index" [selected]="i == 0">
        {{item.content}}
    </p-tabPanel>
</p-tabView>
 

Selection

First tab is selected by default, to customize this enable selected property on another panel.

<p-tabView>
    <p-tabPanel header="Header 1">
       Content 1
    </p-tabPanel>
    <p-tabPanel header="Header 2" [selected]="true">
        Content 2
    </p-tabPanel>
    <p-tabPanel header="Header 3">
        Content 3
    </p-tabPanel>
</p-tabView>
 

Closable

When closable attribute is enabled, an icon is displayed to close the tab. onClose event is fired when a tab is closed.

<p-tabPanel header="Header Text" [closable]="true">
    Content 1
</p-tabPanel>
 

If you'd like to control whether a tab can be closed, enable controlClose property which gives you the control to decide at onClose event. In this case, the event gets a 3rd parameter called close callback and invoking this function actually closes the tab.

<p-tabView [controlClose]="true" (onClose)="handleClose($event)">
    <p-tabPanel header="Header Text" [closable]="true">
        Content 1
    </p-tabPanel>
</p-tabView>
 

handleClose(e) {
   if(condition)
       e.close();
}
 

Disabled

A tab can be disabled to prevent the content to be displayed by setting the disabled property on a panel.

<p-tabPanel header="Header Text" [disabled]="true">
    Content 1
</p-tabPanel>
 

Icons

Icons can be placed at left and right of a header using leftIcon and rightIcon properties of tabPanel.

<p-tabPanel header="Header Text" leftIcon="fa-bell-o" rightIcon="fa-bookmark-o">;
    Content
</p-tabPanel>
 

Header Template

Header of a tab supports templating to place custom html content instead of strings as well.

<p-tabPanel>
    <ng-template pTemplate="header">Custom Content</ng-template>
</p-tabPanel>
 

Orientation

TabView has four different orientations; "top", "bottom", "left" and "right". Top is the default one and this can be changed using orientation attribute.

<p-tabView orientation="left">
 

Programmatic Control

Tabs can be controlled programmatically using activeIndex property that defines the index of the active tab.

<button type="button" pButton icon="fa fa-chevron-up" (click)="openPrev()"></button>
<button type="button" pButton icon="fa fa-chevron-down" (click)="openNext()"></button>
<p-tabView [activeIndex]="index">
    <p-tabPanel header="Header 1">
        Content 1
    </p-tabPanel>
    <p-tabPanel header="Header 2">
        Content 2
    </p-tabPanel>
    <p-tabPanel header="Header 3">
        Content 3
    </p-tabPanel>
</p-tabView>
 

export class TabViewDemo {
    index: number = 0;
    openNext() {
        this.index = (this.index === 2) ? 0 : this.index + 1;
    }
    openPrev() {
        this.index = (this.index === 0) ? 2 : this.index - 1;
    }
}
 

Lazy Loading

Lazy loading helps initial load performance by only initializing the active tab, inactive tabs are not initialized until they get selected. A lazy loaded tabpanel contents are cached by default so that upon reselection, they are not created again. You may use cache property on TabPanel to configure this behavior. A TabPanel is specified as lazy when there is a ngTemplate with pTemplate="content" in it.

<p-tabView>
    <p-tabPanel header="Header 1">
        Content 1
    </p-tabPanel>
    <p-tabPanel header="Header 2">
        <ng-template pTemplate="content">
            Complex Content to Lazy Load
        </ng-template>
    </p-tabPanel>
    <p-tabPanel header="Header 3">
        <ng-template pTemplate="content">
            Complex Content to Lazy Load
        </ng-template>
    </p-tabPanel>
</p-tabView>
 

Properties of TabView

Properties of TabPanel

Events

<p-tabView (onChange)="handleChange($event)">
 

handleChange(e) {
    var index = e.index;
}
 

Styling

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

Dependencies

None.

Source

View on GitHub

<p-toast [style]="{marginTop: '80px'}"></p-toast>
<h3 class="first">Default</h3>
<p-tabView>
    <p-tabPanel header="Godfather I" leftIcon="pi pi-calendar">
        The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war, but does not intend to become part of his father's business. T hrough Michael's life the nature of the family business becomes clear. The business of the family is just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
    </p-tabPanel>
    <p-tabPanel header="Godfather II" leftIcon="pi pi-inbox">
        Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, The_Godfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall, deepening The_Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy, killing the local Black Hand Fanucci after he demands his customary cut of the tyro's business. With Fanucci gone, Vito's communal stature grows.
    </p-tabPanel>
    <p-tabPanel header="Godfather III" leftIcon="pi pi-user" rightIcon="pi pi-star">
        After a break of more than  15 years, director Francis Ford Coppola and writer Mario Puzo returned to the well for this third and final story of the fictional Corleone crime family. Two decades have passed, and crime kingpin Michael Corleone, now divorced from his wife Kay has nearly succeeded in keeping his promise that his family would one day be completely legitimate.
    </p-tabPanel>
</p-tabView>
<h3>Closable</h3>
<p-tabView>
    <p-tabPanel header="Godfather I" [selected]="true">
        The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war, but does not intend to become part of his father's business. T hrough Michael's life the nature of the family business becomes clear. The business of the family is just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
    </p-tabPanel>
    <p-tabPanel header="Godfather II" [closable]="true">
        Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, The_Godfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall, deepening The_Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy, killing the local Black Hand Fanucci after he demands his customary cut of the tyro's business. With Fanucci gone, Vito's communal stature grows.
    </p-tabPanel>
    <p-tabPanel header="Godfather III" [closable]="true">
        After a break of more than  15 years, director Francis Ford Coppola and writer Mario Puzo returned to the well for this third and final story of the fictional Corleone crime family. Two decades have passed, and crime kingpin Michael Corleone, now divorced from his wife Kay has nearly succeeded in keeping his promise that his family would one day be completely legitimate.
    </p-tabPanel>
</p-tabView>
<h3>Event</h3>
<p-tabView (onChange)="onTabChange($event)">
    <p-tabPanel header="Godfather I">
        The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war, but does not intend to become part of his father's business. T hrough Michael's life the nature of the family business becomes clear. The business of the family is just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
    </p-tabPanel>
    <p-tabPanel header="Godfather II" [selected]="true">
        Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, The_Godfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall, deepening The_Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy, killing the local Black Hand Fanucci after he demands his customary cut of the tyro's business. With Fanucci gone, Vito's communal stature grows.
    </p-tabPanel>
    <p-tabPanel header="Godfather III">
        After a break of more than  15 years, director Francis Ford Coppola and writer Mario Puzo returned to the well for this third and final story of the fictional Corleone crime family. Two decades have passed, and crime kingpin Michael Corleone, now divorced from his wife Kay has nearly succeeded in keeping his promise that his family would one day be completely legitimate.
    </p-tabPanel>
    <p-tabPanel header="Godfather IV" [disabled]="true">
        After a break of more than  15 years, director Francis Ford Coppola and writer Mario Puzo returned to the well for this third and final story of the fictional Corleone crime family. Two decades have passed, and crime kingpin Michael Corleone, now divorced from his wife Kay has nearly succeeded in keeping his promise that his family would one day be completely legitimate.
    </p-tabPanel>
</p-tabView>
<h3>Tooltips</h3>
<p-tabView>
    <p-tabPanel header="Godfather I" leftIcon="pi pi-calendar" tooltip="1972">
        The story begins as Don Vito Corleone, the head of a New York Mafia family, overseeshis daughter's wedding. His beloved son ichael has just come home from the war, but does not intend to become part of his father's business. T hrough Michael's life the nature of the family business becomes clear. The business of the family is just like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence whenever anything stands against the good of the family.
    </p-tabPanel>
    <p-tabPanel header="Godfather II" rightIcon="pi pi-inbox" tooltip="1974">
        Francis Ford Coppola's legendary continuation and sequel to his landmark 1972 film, The_Godfather parallels the young Vito Corleone's rise with his son Michael's spiritual fall, deepening The_Godfather's depiction of the dark side of the American dream. In the early 1900s, the child Vito flees his Sicilian village for America after the local Mafia kills his family. Vito struggles to make a living, legally or illegally, for his wife and growing brood in Little Italy, killing the local Black Hand Fanucci after he demands his customary cut of the tyro's business. With Fanucci gone, Vito's communal stature grows.
    </p-tabPanel>
    <p-tabPanel header="Godfather III" leftIcon="pi pi-user" rightIcon="pi pi-star" tooltip="1990">
        After a break of more than  15 years, director Francis Ford Coppola and writer Mario Puzo returned to the well for this third and final story of the fictional Corleone crime family. Two decades have passed, and crime kingpin Michael Corleone, now divorced from his wife Kay has nearly succeeded in keeping his promise that his family would one day be completely legitimate.
    </p-tabPanel>
</p-tabView>
 

export class TabViewDemo {
    constructor(private messageService: MessageService) {}
    onTabChange(event) {
        this.messageService.add({severity:'info', summary:'Tab Expanded', detail: 'Index: ' + event.index});
    }
}