Angular PrimeNG Table Global Filtering

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. This article will show us how to use Table Global Filtering in Angular PrimeNG.

Angular PrimeNG Table Global Filtering enables Global Filter options in the Table component. So, using global filtering options, we can easily search and filter out the required data according to our needs. We use the filterGlobal Method of the table with the value and match mode to implement a global filter on table.

Syntax:

<p-table 
    #tableref 
    [globalFilterFields]="["...", "..."]">
    
    <ng-template pTemplate="caption">
        <input
            type="text"
               pInputText
               (input)="tableref.filterGlobal(
                   $any($event.target).value, 'contains')" />
    </ng-template>
</p-table>

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:

Project Structure

Example 1: Below is a simple example demonstrating the use of the Angular PrimeNG Table Global Filtering.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG Table Global Filtering</h4>

<p-table
    #myTab
    [value]="tableData"
    [scrollable]="true"
    scrollHeight="400px"
    [globalFilterFields]="['firstname', 'lastname', 'age']">
    <ng-template pTemplate="caption">
        <div style="text-align: right">
            <i
                class="pi pi-search"
                style="margin:4px 4px 0 0">
            </i>
            <input
                type="text"
                pInputText
                size="50"
                placeholder="Global Filter"
                (input)=
"myTab.filterGlobal($any($event.target).value, 'contains')"
                style="width:auto"
            />
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Age</th>
        </tr>
    </ng-template>

    <ng-template pTemplate="body" let-people>
        <tr>
            <td>
                {{ people.firstname }}
            </td>
            <td>
                {{ people.lastname }}
            </td>
            <td>
                {{ people.age }}
            </td>
        </tr>
    </ng-template>
</p-table>

app.component.ts

import { Component } from "@angular/core";

interface People {
    firstname?: string;
    lastname?: string;
    age?: string;
}

@Component({
    selector: "app-root",
    templateUrl: "./app.component.html",
})
export class AppComponent {
    tableData: People[] = [];
    cols: any[] = [];
    constructor() { }

    ngOnInit() {
        this.cols = [
            { field: "firstname", header: "First Name" },
            { field: "lastname", header: "Last Name" },
            { field: "age", header: "Age" },
        ];
        this.tableData = [
            {
                firstname: "David",
                lastname: "ace",
                age: "40",
            },
            {
                firstname: "AJne",
                lastname: "west",
                age: "40",
            },
            {
                firstname: "Mak",
                lastname: "Lame",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
        ];
    }
}

app.module.ts

import { NgModule } from '@angular/core';
import { BrowserModule }
    from '@angular/platform-browser';
import { FormsModule } from '@angular/forms';
import { BrowserAnimationsModule }
    from '@angular/platform-browser/animations';

import { AppComponent } from './app.component';
import { TableModule } from 'primeng/table';
import { InputTextModule } from 'primeng/inputtext';

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        FormsModule,
        InputTextModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})

export class AppModule { }

Output:

Example 2: Below is another example demonstrating the use of the Angular PrimeNG Table Global Filtering. In this example, we are removing the last name from global filter fields i.e if we filter the table using the last name column values, it will not work. 

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG Table Global Filtering</h4>

<p-table
    #myTab
    [value]="tableData"
    [scrollable]="true"
    scrollHeight="400px"
    [globalFilterFields]="['firstname', 'age']">
    <ng-template pTemplate="caption">
        <div style="text-align: right">
            <i
                class="pi pi-search"
                style="margin:4px 4px 0 0">
            </i>
            <input
                type="text"
                pInputText size="50"
                placeholder="Global Filter"
                (input)=
"myTab.filterGlobal($any($event.target).value, 'contains')"
                style="width:auto" />
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th>First Name</th>
            <th>Last Name</th>
            <th>Age</th>
        </tr>
    </ng-template>

    <ng-template pTemplate="body" let-people>
        <tr>
            <td>
                {{ people.firstname }}
            </td>
            <td>
                {{ people.lastname }}
            </td>
            <td>
                {{ people.age }}
            </td>
        </tr>
    </ng-template>
</p-table>

app.component.ts

import { Component } from "@angular/core";

interface People {
    firstname?: string;
    lastname?: string;
    age?: string;
}

@Component({
    selector: "app-root",
    templateUrl: "./app.component.html",
})
export class AppComponent {
    tableData: People[] = [];
    cols: any[] = [];
    constructor() { }

    ngOnInit() {
        this.cols = [
            { field: "firstname", header: "First Name" },
            { field: "lastname", header: "Last Name" },
            { field: "age", header: "Age" },
        ];
        this.tableData = [
            {
                firstname: "David",
                lastname: "ace",
                age: "40",
            },
            {
                firstname: "AJne",
                lastname: "west",
                age: "40",
            },
            {
                firstname: "Mak",
                lastname: "Lame",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
            {
                firstname: "Peter",
                lastname: "raw",
                age: "40",
            },
            {
                firstname: "Kane",
                lastname: "James",
                age: "40",
            },
        ];
    }
}

app.module.ts

import { NgModule } from '@angular/core';
import { BrowserModule }
    from '@angular/platform-browser';
import { FormsModule } from '@angular/forms';
import { BrowserAnimationsModule }
    from '@angular/platform-browser/animations';

import { AppComponent } from './app.component';
import { TableModule } from 'primeng/table';
import { InputTextModule } from 'primeng/inputtext';

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        FormsModule,
        InputTextModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})

export class AppModule { }

Output:

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