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

The PickList Component is used to reorder items between different categories and lets us pick and select items. It acts as a drag-and-drop component with two tables and contents in it.

Filtering: We can enable filtering by the filterBy property. Options can be filtered using an input field in the overlay.

Creating Angular application & Module Installation:

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

ng new geeks_angular

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

cd geeks_angular

Step 3: Install PrimeNG and CDK in your given directory.

npm install primeng --save
npm install primeicons --save
npm install @angular/cdk --save

Project Structure: The project structure will look like the following:

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

ng serve --save

Example 1: This example describes the basic usage of the basic Picklist Filtering in Angular PrimeNG using filterBy=”category” property.

• app.component.html:

HTML

<h1 style="color: green; text-align: center;">
    GeeksforGeeks
</h1>
<h3>Angular PrimeNG Picklist Filtering</h3>
<p-pickList
    ="sourceTutorials"
    [target]="targetTutorials"
    sourceHeader="Tutorials Available in GeeksforGeeks"
    targetHeader="Selected Tutorials from GeeksforGeeks"
    dragdrop="true"
    filterBy="category"
    [responsive]="true"
    sourceFilterPlaceholder="Search by category"
    targetFilterPlaceholder="Search by category"
    [sourceStyle]="{ height: '500px' }"
    [targetStyle]="{ height: '500px' }">
    <ng-template let-tutorial pTemplate="item">
        <div>
            <div>
                <h5 class="mb-2">
                    {{ tutorial.title }}
                </h5>
                <h5>{{ tutorial.category }}</h5>
                <h6 class="mb-2">
                    Rating: {{ tutorial.rating }}
                </h6>
            </div>
        </div>
    </ng-template>
</p-pickList>

• app.component.ts:

Javascript

import { Component } from "@angular/core";
import { PrimeNGConfig } from "primeng/api";

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

export class AppComponent {
    sourceTutorials: Tutorial[];
    targetTutorials: Tutorial[];

    constructor(private primengConfig: PrimeNGConfig) {}

    ngOnInit() {
        this.sourceTutorials = [
            {
                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.targetTutorials = [];
        this.primengConfig.ripple = true;
    }
}
export interface Tutorial {
    category?: string;
    title?: string;
    rating?: number;
}

• app.module.ts:

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { HttpClientModule } from "@angular/common/http";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { PickListModule } from "primeng/picklist";

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

export class AppModule {}

Output:

Example 2: This example describes the basic usage of the basic Picklist Filtering in Angular PrimeNG using filterBy=”rating” property. We’ll be using Template to customize the search bar.

• app.component.html:

HTML

<h1 style="color: green; text-align: center;">
    GeeksforGeeks
</h1>
<h3>Angular PrimeNG Picklist Filtering</h3>
<p-pickList
    ="sourceTutorials"
    [target]="targetTutorials"
    sourceHeader="Tutorials Available in GeeksforGeeks"
    targetHeader="Selected Tutorials from GeeksforGeeks"
    dragdrop="true"
    filterBy="rating"
    [responsive]="true"
    [sourceStyle]="{ height: '500px' }"
    [targetStyle]="{ height: '500px' }">
    <ng-template pTemplate="sourceFilter" let-options="options">
        <div class="p-picklist-filter">
            <input
                [(ngModel)]="sourceSearch"
                type="text"
                (keyup)="options.filter($event.target.value)"
                role="textbox"
                class="p-picklist-filter-input p-inputtext p-component" />
            <span
                *ngIf="sourceSearch"
                class="p-picklist-filter-icon pi pi-times"
                (click)="options.reset(); sourceSearch = ''">
              </span>
        </div>
    </ng-template>

    <ng-template pTemplate="targetFilter" let-options="options">
        <div class="p-picklist-filter">
            <input
                [(ngModel)]="targetSearch" type="text"
                (keyup)="options.filter($event.target.value)"
                role="textbox" class="p-picklist-filter-input
                    p-inputtext p-component" />
            <span
                *ngIf="targetSearch"
                class="p-picklist-filter-icon pi pi-times"
                (click)="options.reset(); targetSearch = ''">
              </span>
        </div>
    </ng-template>
    <ng-template let-tutorial pTemplate="item">
        <div>
            <div>
                <h5 class="mb-2">
                    {{ tutorial.title }}
                </h5>
                <h5>{{ tutorial.category }}</h5>
                <h6 class="mb-2">Rating: {{ tutorial.rating }}</h6>
            </div>
        </div>
    </ng-template>
</p-pickList>

• app.component.ts:

Javascript

import { Component } from '@angular/core';
import { PrimeNGConfig } from 'primeng/api';
import { PickListFilterOptions } from 'primeng/picklist';

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

export class AppComponent {
    sourceTutorials: Tutorial[];
    targetTutorials: Tutorial[];

    constructor(private primengConfig: PrimeNGConfig) { }

    ngOnInit() {
        this.sourceTutorials = [
            {
                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.targetTutorials = [];
        this.primengConfig.ripple = true;
    }

  sourceSearch: string = '';
  targetSearch: string = '';
}

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

• app.module.ts:

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { HttpClientModule } from "@angular/common/http";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { PickListModule } from "primeng/picklist";

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

export class AppModule {}

Output:

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