Angular PrimeNG Chips Component

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. In this article, we will know how to use the Chips component in Angular PrimeNG.

Chips component: It is used to set multiple values to enter for an input field.

Properties:

• field: It is used to set the name of the property to display on a chip. It is of string data type, the default value is null.
• max: It is used to set the maximum number of entries allowed. It is of number datatype, the default value is null.
• disabled: It is used to disable the checkbox. It is of the boolean data type, the default value is false.
• style: It is used to give the inline style of the component. It is of string data type, the default value is null.
• styleClass: It is the style class of the component. It is of string data type, the default value is null.
• placeholder: It is used to set the placeholder text for the input. It is of string data type, the default value is null.
• tabindex: It is used to set the index of the element in tabbing order. It is of number datatype, the default value is null.
• inputId: It is an ID identifier of the underlying input element. It is of string data type, the default value is null.
• ariaLabelledBy: This property establishes relationships between the component and label(s) where its value should be one or more element IDs. It is of string data type, the default value is null.
• allowDuplicate: It is used to set whether to allow duplicate values or not. It is of the boolean data type, the default value is true.
• inputStyle: It is used to set the inline style of the input field. It is of string data type, the default value is null.
• inputStyleClass: It is used to set the style class of the input field. It is of string data type, the default value is null.
• addOnTab: It is used to set whether to add an item on tab keypress. It is of the boolean data type, the default value is false.
• addOnBlur: It is used to set whether to add an item when the input loses focus. It is of the boolean data type, the default value is false.
• separator: It is used to set the separator char to add an item when pressed in addition to the enter key. It is of string data type, the default value is null.

Events:

• onAdd: It is a callback that is fired when a value is added.
• onRemove: It is a callback that is fired when a value is removed.
• onChipClick: It is a callback that is fired when a chip is clicked.
• onFocus: It is a callback that is fired when an input is focused.
• onBlur: It is a callback that is fired when an input loses focus.

Styling:

• p-chips: It is a container element.
• p-chips-token: It is a chip element container.
• p-chips-token-icon: It is an icon of a chip.
• p-chips-token-label: It is a label of a chip.
• p-chips-input-token: It is a container of input elements.

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:

Example 1: This is the basic example that shows how to use the Chips component.

app.component.html

<div>
  <h2>GeeksforGeeks</h2>
  <h4>PrimeNG chips component</h4>
  <p-chips></p-chips>
</div>

app.component.ts

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

@Component({
  selector: 'my-app',
  templateUrl: './app.component.html'
})
export class AppComponent {}

app.module.ts

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 { ChipsModule } from "primeng/chips";
import { ButtonModule } from "primeng/button";

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    ChipsModule,
    ButtonModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})
export class AppModule {}

Output:

Example 2: In this example, we have a template for the Chips component.

app.component.html

<h5>PrimeNG Chips Component</h5>
<p-chips [(ngModel)]="geeks">
  <ng-template let-gfg pTemplate="gfg">
    {{gfg}}<i class="pi pi-user p-ml-2"></i>
  </ng-template>
</p-chips>

app.component.ts

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

@Component({
  selector: "my-app",
  templateUrl: "./app.component.html",
})
export class AppComponent {
  geeks: string[];
}

app.module.ts

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 { ChipsModule } from "primeng/chips";
import { ButtonModule } from "primeng/button";

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    ChipsModule,
    ButtonModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})
export class AppModule {}

Output:

Reference: https://primeng.org/chips