Angular PrimeNG Table TableHeaderCheckbox Properties

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 are going to learn Angular PrimeNG Table TableHeaderCheckbox Properties.

Angular PrimeNG Table is used to display data in tabular format. The TableHeaderCheckbox Properties is used to control the checkboxes and we can modify them according to choice.

Angular PrimeNG Table TableHeaderCheckbox Properties:

• value(any): It is the row data value of the component.
• index(number): It is the index of the row.
• disabled(boolean): It sets whether the component is disabled.
• inputId(string): It is the identifier of the checkbox.
• name(string): It is the name of the checkbox.
• required(boolean): If set to true, it specifies that the checkbox must be checked before submitting the form. False has been set as the default value.
• ariaLabel(string): It defines a string that labels the checkbox for accessibility.

Syntax:

<p-table 
    [value]="data" 
    [index]="1"> 
</p-table>

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 in your given directory.

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

Project Structure:

Example 1: In the following example, we have a simple Table and we have disabled the checkbox

• app.component.html

HTML

<h1 style="color:green;text-align:center;">
    GeeksforGeeks
</h1>
<h3>
    Angular PrimeNG Table TableHeaderCheckbox Properties
</h3>
<h5>Basic</h5>

<p-table
    #dt [value]="tutorials"
    dataKey="title"
    [rowHover]="true"
    [showCurrentPageReport]="true"
    [filterDelay]="1000"
    [globalFilterFields]="['title', 'category', 'rating']">
    <ng-template pTemplate="caption">
        <div class="table-header">
            List of Tutorials
            <span class="p-input-icon-left">
                <i class="pi pi-search"></i>
                <input
                    pInputText type="text"
                    (input)="dt.filterGlobal($event.target.value, 'contains')"
                    placeholder="Global Search" />
            </span>
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th style="width: 3rem"></th>
            <th pSortableColumn="title">
                Title <p-sortIcon field="title"></p-sortIcon>
            </th>
            <th pSortableColumn="category">
                Category <p-sortIcon field="category"></p-sortIcon>
            </th>
            <th pSortableColumn="rating">
                Rating <p-sortIcon field="rating"></p-sortIcon>
            </th>
        </tr>
    </ng-template>
    <ng-template pTemplate="body" let-tutorial>
        <tr class="p-selectable-row">
            <td>
                <p-tableCheckbox
                    [value]="tutorial"
                    [disabled]="true">
                </p-tableCheckbox>
            </td>
            <td>
                <span class="p-column-title">
                    Title
                </span>
                {{ tutorial.title }}
            </td>
            <td>
                <span class="p-column-title">
                    Category
                </span>
                <span class="image-text">
                    {{ tutorial.category }}
                </span>
            </td>
            <td>
                <span class="p-column-title">
                    Rating
                </span>
                <span class="image-text">
                    {{ tutorial.rating }}
                </span>
            </td>
        </tr>
    </ng-template>
</p-table>

• app.component.ts

Javascript

import { Component, OnInit, ViewChild } from '@angular/core';
import { Table } from 'primeng/table';
import { PrimeNGConfig } from 'primeng/api';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
})
export class AppComponent {
    tutorials: Tutorial[];
    @ViewChild('dt') table: Table;

    constructor(private primengConfig: PrimeNGConfig) { }

    ngOnInit() {
        this.tutorials = [
            {
                title: 'Queue',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Circularly LinkedList',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Doubly LinkedList',
                category: 'Data Structure',
                rating: 3
            },
            {
                title: 'Singly LinkedList',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Doubly Ended Queue',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Binary Search Tree',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Red Black Tree',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Breadth First Search',
                category: 'Graph',
                rating: 4
            },
            {
                title: "Floyd's Cycle",
                category: 'Algorithm',
                rating: 4
            },
            {
                title: 'Travelling Salesman Problem',
                category: 'Algorithm',
                rating: 5,
            },
            {
                title: 'Bellman Ford',
                category: 'Graph',
                rating: 4
            },
            {
                title: 'KMP Algorithm',
                category: 'String',
                rating: 5
            },
        ];

        this.primengConfig.ripple = true;
    }
}
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 { FormsModule } from '@angular/forms';
import { HttpClientModule } from '@angular/common/http';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

import { AppComponent } from './app.component';

import { TableModule } from 'primeng/table';
import { CalendarModule } from 'primeng/calendar';
import { SliderModule } from 'primeng/slider';
import { DialogModule } from 'primeng/dialog';
import { MultiSelectModule } from 'primeng/multiselect';
import { ContextMenuModule } from 'primeng/contextmenu';
import { ButtonModule } from 'primeng/button';
import { ToastModule } from 'primeng/toast';
import { InputTextModule } from 'primeng/inputtext';
import { ProgressBarModule } from 'primeng/progressbar';
import { DropdownModule } from 'primeng/dropdown';

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        CalendarModule,
        SliderModule,
        DialogModule,
        MultiSelectModule,
        ContextMenuModule,
        DropdownModule,
        ButtonModule,
        ToastModule,
        InputTextModule,
        ProgressBarModule,
        HttpClientModule,
        FormsModule,
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})
export class AppModule { }

Output:

Example 2: In the following example, we have added conditionally disabled if the rating is less than 5 and we can edit the cell rating to change the selection criteria.

• app.component.html

HTML

<h1 style="color:green;text-align:center;">GeeksforGeeks</h1>
<h3>Angular PrimeNG Table TableHeaderCheckbox Properties</h3>
<h5>Basic</h5>

<p-table #dt [value]="tutorials"
         dataKey="title"
         [rowHover]="true"
         [showCurrentPageReport]="true"
         [filterDelay]="1000"
    [globalFilterFields]="['title', 'category', 'rating']">
    <ng-template pTemplate="caption">
        <div class="table-header">
            List of Tutorials
            <span class="p-input-icon-left">
                <i class="pi pi-search"></i>
                <input pInputText type="text"
                       (input)="dt.filterGlobal($event.target.value, 'contains')"
                    placeholder="Global Search" />
            </span>
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th style="width: 3rem"></th>
            <th pSortableColumn="title">
                Title <p-sortIcon field="title"></p-sortIcon>
            </th>
            <th pSortableColumn="category">
                Category <p-sortIcon field="category"></p-sortIcon>
            </th>
            <th pSortableColumn="rating">
                Rating <p-sortIcon field="rating"></p-sortIcon>
            </th>
        </tr>
    </ng-template>
    <ng-template pTemplate="body" let-tutorial
                 let-rowIndex="rowIndex">
        <tr class="p-selectable-row">
            <td>
                <p-tableCheckbox [value]="tutorial"
                                 [index]="rowIndex"
                                 [disabled]="tutorial.rating < 5">
                </p-tableCheckbox>
            </td>
            <td>
                <span class="p-column-title"> Title </span>
                {{ tutorial.title }}
            </td>
            <td>
                <span class="p-column-title"> Category </span>
                <span class="image-text">
                    {{ tutorial.category }}
                </span>
            </td>
            <td pEditableColumn>
                <p-cellEditor>
                    <ng-template pTemplate="input">
                        <input type="text"
                               [(ngModel)]="tutorial.rating" />
                    </ng-template>
                    <ng-template pTemplate="output">
                        {{ tutorial.rating }}
                    </ng-template>
                </p-cellEditor>
            </td>
        </tr>
        </ng - template>
        </p - table>

• app.component.ts

Javascript

import { Component, OnInit, ViewChild } from '@angular/core';
import { Table } from 'primeng/table';
import { PrimeNGConfig } from 'primeng/api';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
})
export class AppComponent {
    tutorials: Tutorial[];
    @ViewChild('dt') table: Table;

    constructor(private primengConfig: PrimeNGConfig) { }

    ngOnInit() {
        this.tutorials = [
            {
                title: 'Queue',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Circularly LinkedList',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Doubly LinkedList',
                category: 'Data Structure',
                rating: 3
            },
            {
                title: 'Singly LinkedList',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Doubly Ended Queue',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Binary Search Tree',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Red Black Tree',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Breadth First Search',
                category: 'Graph',
                rating: 4
            },
            {
                title: "Floyd's Cycle",
                category: 'Algorithm',
                rating: 4
            },
            {
                title: 'Travelling Salesman Problem',
                category: 'Algorithm',
                rating: 5,
            },
            {
                title: 'Bellman Ford',
                category: 'Graph',
                rating: 4
            },
            {
                title: 'KMP Algorithm',
                category: 'String',
                rating: 5
            },
        ];

        this.primengConfig.ripple = true;
    }
}
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 { FormsModule } from '@angular/forms';
import { HttpClientModule } from '@angular/common/http';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

import { AppComponent } from './app.component';

import { TableModule } from 'primeng/table';
import { CalendarModule } from 'primeng/calendar';
import { SliderModule } from 'primeng/slider';
import { DialogModule } from 'primeng/dialog';
import { MultiSelectModule } from 'primeng/multiselect';
import { ContextMenuModule } from 'primeng/contextmenu';
import { ButtonModule } from 'primeng/button';
import { ToastModule } from 'primeng/toast';
import { InputTextModule } from 'primeng/inputtext';
import { ProgressBarModule } from 'primeng/progressbar';
import { DropdownModule } from 'primeng/dropdown';

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        CalendarModule,
        SliderModule,
        DialogModule,
        MultiSelectModule,
        ContextMenuModule,
        DropdownModule,
        ButtonModule,
        ToastModule,
        InputTextModule,
        ProgressBarModule,
        HttpClientModule,
        FormsModule,
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})
export class AppModule { }

Output: 

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