Angular PrimeNG Table Filter Menu

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 Filtering in Angular PrimeNG.

Angular PrimeNG Table Filter Menu enables the Filter menu in the Table component. A filter menu is used to filter columns based on some criteria. It is more advanced than separate rows as it provides us with more filter options with multiple operators.

Syntax:

<p-table 
    #myTab 
    [value]="..." 
    [scrollable]="..." 
    scrollHeight="...px">

    <ng-template pTemplate="header">
        <tr>
            <th>Name</th>
            <p-columnFilter 
                type="text" 
                field="firstname" 
                display="menu">
            </p-columnFilter>
            ...
        </tr>
    </ng-template>

    <ng-template pTemplate="body" let-x>
        <tr>
            <td>
                {{ x.name }}
            </td>
            ...
        </tr>
    </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 Filter Menu.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG Table Filter Menu</h4>

<p-table
    #myTab
    [value]="tableData"
    [scrollable]="true"
    scrollHeight="400px">

    <ng-template pTemplate="header">
        <tr>
            <th>First Name</th>
            <p-columnFilter
                type="text"
                field="firstname"
                display="menu">
            </p-columnFilter>
            <th>Last Name</th>
            <p-columnFilter
                type="text"
                field="lastname"
                display="menu">
            </p-columnFilter>
            <th>Age</th>
            <p-columnFilter
                type="text" field="age"
                display="menu">
            </p-columnFilter>
        </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';

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

export class AppModule { }

Output:

Example 2: Below is another example demonstrating the use of the Angular PrimeNG Table Filter Menu. In this example, we are applying the filter only to the first name column.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG Table Filter Menu</h4>

<p-table
    #myTab
    [value]="tableData"
    [scrollable]="true"
    scrollHeight="400px">

    <ng-template pTemplate="header">
        <tr>
            <th>First Name</th>
            <p-columnFilter
                type="text"
                field="firstname"
                display="menu">
            </p-columnFilter>
            <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';

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

export class AppModule { }

Output:

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