Post
Ask Question

Built-In And Custom Pipes In Angular

What are Pipes in Angular?
  • Pipes in Angular are used to transform the data before displaying to view.
  • Angular has some built-In pipes like lowercase, uppercase, date, percent, currency, etc. However, we can also create custom pipes as per our application requirement.
  • And to achieve this transformation we use the pipe operator ( | ).
I will show you examples of both Built-In and Custom Pipes.
 
Let's start by creating a component in the application.
 
Execute command
"ng g c CustomPipeDemo"   ( g = generate, c=component ) in your workspace.
 
Navigate to custom-pipe-demo.component.ts file.
 
Update your code as show below,
  1. import { Component, OnInit } from '@angular/core';  
  2.   
  3. @Component({  
  4.   selector: 'app-custom-pipe-demo',  
  5.   templateUrl: './custom-pipe-demo.component.html',  
  6.   styleUrls: ['./custom-pipe-demo.component.css']  
  7. })  
  8. export class CustomPipeDemoComponent implements OnInit {  
  9.   
  10.   name:string="Jay";  
  11.   
  12.   salary:number=78000;  
  13.   
  14.   birthday = new Date(1962, 5, 21); // June 21, 1962  
  15.   
  16.   constructor() { }  
  17.   
  18.   ngOnInit() {  
  19.   }  
  20.   
  21. }  
Basically, we just declared & initialized 3 variables in CustomPipeDemoComponent class - name, salary & birthday.
 
Now, as you can see the templateUrl points to custom-pipe-demo.component.html  so let's navigate to this file and update the code. 
  1. <h3>Angular Pipes Demo</h3>  
  2.   
  3. <h3>Angular Built-In Pipes Demo</h3>  
  4.   
  5. <p>Uppercase - {{name | uppercase}}</p>  
  6. <p>Lowercase - {{name | lowercase}}</p>  
  7.   
  8. <p>Currency - {{salary | currency:'INR'}}</p>  
  9.   
  10. <p>Date - {{birthday | date:'dd/MM/yyyy'}}</p>  

The code above shows you how we transform the value in using various pipes.
 
Firstly, I have used uppercase & lowercase pipe to display the name in the respective format. Secondly, I have used currency pipe to display the currency symbol before salary. Finally, I have used the date pipe to display the Date in format "DD-MM-  YYYY".
 
Let's see the output with these changes,
  
Custom Pipes in Angular
 
Now, let's see how can we chain the pipes. Chaining pipes means to use multiple pipes together with proper combinations.
 
Add the below code in HTML file and see the output,
  1. <h3>Angular Chained Pipes Demo</h3>  
  2.   
  3. <p>Uppercase Date - {{birthday | date:'dd/MMMM/yyyy' | uppercase}}</p>  
  4. <p>Lowercase Date - {{birthday | date:'dd/MMMM/yyyy' | lowercase}}</p>  
 
 As you can see above we have used two combinations of pipes - date & uppercase/lowercase respectively. So, the result of these would be a date in the specified format with uppercase/lowercase applied respectively.
 
Let's see the output with updated changes,
 
Custom Pipes in Angular
    
Finally, now let's see the custom pipes.
 
Let's take an example of a leap year. We will input a year in a textbox and display whether this is a leap year or not. Something like as shown below,
 
Custom Pipes in Angular
Let's add this input in our HTML file,
  1. <h3>Angular Custom Pipes Demo</h3>  
  2.   
  3. <input type="text" placeholder="Year" name="txtYear" [(ngModel)]="txtYear"/>  
  4.   
As you can see above we have created a textbox and used [(ngModel)] for binding the text input. Now, using this text input we need to display whether the year is a leap year or not. 
 
Let's create a custom pipe to achieve this.
 
Execute command
"ng g p IsLeapyear"  ( g = generate, p=pipe) in your workspace.
 
Navigate to the is-leap-year.pipe.ts file and update the code as shown below,
  1. import { Pipe, PipeTransform } from '@angular/core';  
  2.   
  3. @Pipe({  
  4.   name: 'isLeapYear'  
  5. })  
  6. export class IsLeapYearPipe implements PipeTransform {  
  7.   
  8.   transform(value: any, args?: any): any {  
  9.       
  10.     if(value==undefined || value == null || value=="")  
  11.       return false;  
  12.   
  13.     if(value%4==0)  
  14.       return true;  
  15.     else  
  16.       return false;  
  17.   }  
  18.   
  19. }  
Basically, pipe implements a PipeTransform interface where we need to implement pipe logic in a transform method.
 
Transform method has 2 parameters and a return type any,
  1. Value (For receiving the value we passed to this pipe for transformation)
  2. args?  (Optional - For receiving the additional arguments to the value)
Basically, we can change this return type as per our requirement. But for this, I kept it as it is though our program returns boolean. 
 
Now, we need to pass the Year value from HTML &  transform it with Pipe (see the pipe name) to display true/false. So, we will update the HTML code as shown below,
 
Note
isLeapYear is our pipe name. 
  1. Leap Year - {{txtYear | isLeapYear}}  
Now, see the output by entering different Year inputs to the text field. You will get the results as shown below,
 
   Custom Pipes in Angular
That's it! I hope you like this blog. Angular is a really interesting framework to learn and work on.