Angular PrimeNG Dynamic OverlayPanel Templates

Angular PrimeNG is an open-source framework with a rich set of native Angular UI components that are used for great styling and this framework is used to make responsive websites with very much ease. It provides a lot of templates, components, theme design, an extensive icon library, and much more. In this article, we will see the Angular PrimeNG Dynamic OverlayPanel Templates.

OverlayPanel is a container component positioned as connected to its target. It appears normally when a button is clicked as a pop-up with some action to take as selecting an item and then closing it. It is said to be dynamic because it does not appear on the first mount but appears on interaction with the website. The templates in OverlayPanel are used to put some content on some pre-structured containers and we don’t need to modify much to suit different needs.

Angular PrimeNG Dynamic OverlayPanel Templates:

• content: This is used to put the body of the OverlayPanel. This is the container element

Syntax: 

• Import the module:

import {OverlayPanelModule} from 'primeng/overlaypanel';

• Use it as follows:

<p-overlayPanel #op>
    <ng-template pTemplate>
        .....
    </ng-template>
</p-overlayPanel>

<button type="text" pButton label="...." 
      (click)="....">
</button>

Creating Angular application & module installation:

Step 1: Create an Angular application using the following command.

ng new appname

Step 2: After creating your project folder i.e. appname, move to it using the following command.

cd appname

Step 3: Install PrimeNG in your given directory.

npm install primeng --save
npm install primeicons --save

Project Structure: It will look like the following:

• Steps to run the application: Run the below command to see the output

ng serve --save

Example 1: Below is the example code that illustrates the use of Angular PrimeNG OverlayPanel Templates, where we will simply place some text as the content in the container element of the overlay panel.

• app.component.html:

HTML

<div style="width: 80%;">
    <h1 style="color: green;">
          GeeksforGeeks
      </h1>
    <h2>
          Angular PrimeNG Dynamic OverlayPanel Templates
      </h2>
    <p-button [label]="'Open Panel'"
              icon="pi pi-search"
              (click)="op.toggle($event)">
    </p-button>

    <p-overlayPanel #op [showCloseIcon]="true"
        [style]="{ width: '450px' }">
        <ng-template pTemplate>
            Welcome to GeeksforGeeks
        </ng-template>
    </p-overlayPanel>
</div>

• app.component.ts:

Javascript

import { Component } from "@angular/core";
import { OverlayPanel } from "primeng/overlaypanel";
import { MessageService } from "primeng/api";

@Component({
    selector: "app-root",
    templateUrl: "./app.component.html"
})

export class AppComponent {
    constructor(private messageService: MessageService) { }

    ngOnInit() { }
}

• app.module.ts:

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule }
    from "@angular/platform-browser";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { ButtonModule } from "primeng/button";
import { OverlayPanelModule }
    from "primeng/overlaypanel";
import { MessageService } from "primeng/api";

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        OverlayPanelModule,
        ButtonModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
    providers: [MessageService]
})

export class AppModule {}

Output:

Example 2: Below is another example code that illustrates the use of Angular PrimeNG OverlayPanel Templates, where we have a table by implementing the pagination with the OverlayPanel Component.

• app.component.html:

HTML

<div style="width: 80%;">
    <h1 style="color: green;">
          GeeksforGeeks
      </h1>
    <h2>
          Angular PrimeNG Dynamic OverlayPanel Templates
      </h2>
    <p-button [label]="'Overlay Panel'"
              icon="pi pi-search"
              (click)="op1.toggle($event)">
    </p-button>

    <p-overlayPanel #op1 [showCloseIcon]="true"
                          [style]="{ width: '450px' }">
        <p-table #dt [columns]="cols"
                     [value]="tutorials"
                     [paginator]="true"
                     [rows]="3"
                     responsiveLayout="scroll">
            <ng-template pTemplate="body"
                 let-rowData let-columns="columns">
                <tr [pSelectableRow]="rowData">
                    <td *ngFor="let col of columns">
                        {{ rowData[col.field] }}
                    </td>
                </tr>
            </ng-template>
        </p-table>
    </p-overlayPanel>
</div>

• app.component.ts:

Javascript

import { Component } from "@angular/core";
import { OverlayPanel } from "primeng/overlaypanel";
import { MessageService } from "primeng/api";

@Component({
    selector: "app-root",
    templateUrl: "./app.component.html"
})

export class AppComponent {
    constructor(private messageService: MessageService) { }
    tutorials: Tutorial[] = [];
    cols: any[] = [];
    ngOnInit() {
        this.tutorials = [
            {
                title: "Queue",
                category: "Data Structure",
                rating: 8
            },
            {
                title: "Circularly LinkedList",
                category: "Data Structure",
                rating: 1
            },
            {
                title: "Doubly LinkedList",
                category: "Data Structure",
                rating: 3
            },
            {
                title: "Singly LinkedList",
                category: "Data Structure",
                rating: 5
            },
            {
                title: "Doubly Ended Queue",
                category: "Data Structure",
                rating: 10
            },
            {
                title: "Binary Search Tree",
                category: "Data Structure",
                rating: 2
            },
            {
                title: "Red Black Tree",
                category: "Data Structure",
                rating: 9
            },
            {
                title: "Breadth First Search",
                category: "Graph",
                rating: 6
            },
            {
                title: "Floyd's Cycle",
                category: "Algorithm",
                rating: 7
            },
            {
                title: "Travelling Salesman Problem",
                category: "Algorithm",
                rating: 4
            },
            {
                title: "Bellman Ford",
                category: "Graph",
                rating: 8
            },
            {
                title: "KMP Algorithm",
                category: "String",
                rating: 10
            }
        ];
        this.cols = [
            { field: "title", header: "Title" },
            { field: "category", header: "Category" },
            { field: "rating", header: "Rating" }
        ];
    }
}

export interface Tutorial {
    title?: string;
    category?: string;
    rating?: number;
}

• app.module.ts:

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule }
    from "@angular/platform-browser";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { ButtonModule } from "primeng/button";
import { OverlayPanelModule }
    from "primeng/overlaypanel";
import { MessageService } from "primeng/api";
import { TableModule } from "primeng/table";

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        OverlayPanelModule,
        ButtonModule,
        TableModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
    providers: [MessageService]
})

export class AppModule { }

Output:

Reference: https://primefaces.org/primeng/overlaypanel