Creating custom pipes in Angular

Introduction

Custom pipes help you change how data looks in your app. They make your templates cleaner and your code easier to read.

You want to format dates in a special way not covered by built-in pipes.

You need to shorten long text with an ellipsis.

You want to convert text to uppercase but only for certain words.

You want to filter or transform a list before showing it.

You want to create reusable formatting logic for numbers or strings.

Syntax

Angular

import { Pipe, PipeTransform } from '@angular/core';

@Pipe({
  name: 'pipeName'
})
export class PipeNamePipe implements PipeTransform {
  transform(value: any, ...args: any[]): any {
    // your transformation logic here
    return transformedValue;
  }
}

The @Pipe decorator defines the pipe's name used in templates.

The transform method takes the input value and optional arguments, then returns the transformed output.

Examples

This pipe adds an exclamation mark to any string.

Angular

import { Pipe, PipeTransform } from '@angular/core';

@Pipe({ name: 'exclaim' })
export class ExclaimPipe implements PipeTransform {
  transform(value: string): string {
    return value + '!';
  }
}

This pipe shortens text to a given length and adds '...' if it was cut.

Angular

import { Pipe, PipeTransform } from '@angular/core';

@Pipe({ name: 'truncate' })
export class TruncatePipe implements PipeTransform {
  transform(value: string, limit: number): string {
    return value.length > limit ? value.substring(0, limit) + '...' : value;
  }
}

Sample Program

This example shows a custom pipe named reverse that flips a string backwards. The component uses it to show the original and reversed text.

Angular

import { Component } from '@angular/core';
import { Pipe, PipeTransform } from '@angular/core';

@Pipe({
  name: 'reverse'
})
export class ReversePipe implements PipeTransform {
  transform(value: string): string {
    return value.split('').reverse().join('');
  }
}

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [ReversePipe],
  template: `<h1>Original: {{ text }}</h1><h2>Reversed: {{ text | reverse }}</h2>`
})
export class AppComponent {
  text = 'hello';
}

Important Notes

Always name your pipes with lowercase letters and no spaces for easy use in templates.

Custom pipes should be pure by default, meaning they only change output when input changes, for better performance.

Remember to add your pipe to the module or use standalone components to make it available.

Summary

Custom pipes let you change how data looks in your Angular templates.

They use a transform method to convert input to output.

Use them to keep your templates clean and reuse formatting logic.

Practice

1. What is the main purpose of creating a custom pipe in Angular?

easy

A. To manage component lifecycle hooks

B. To handle HTTP requests

C. To define routing paths

D. To transform data in templates for display

Solution

1. Step 1: Understand the role of pipes in Angular

   Pipes are used to transform data before displaying it in templates.

2. Step 2: Identify what custom pipes do

   Custom pipes let you create your own data transformations to keep templates clean and reusable.

3. Final Answer:

   To transform data in templates for display -> Option D

4. Quick Check:

   Custom pipes = transform data [OK]

Hint: Pipes change how data looks in templates [OK]

Common Mistakes:

• Confusing pipes with services
• Thinking pipes handle HTTP or routing
• Mixing pipes with component lifecycle

2. Which of the following is the correct way to define a custom pipe class in Angular?

easy

A. export class MyPipe implements PipeTransform { transform(value: any): any { return value; } }

B. export class MyPipe { transform(value: any): any { return value; } }

C. export function MyPipe(value: any): any { return value; }

D. export class MyPipe implements OnInit { transform(value: any): any { return value; } }

Solution

1. Step 1: Recall Angular pipe class requirements

   A custom pipe class must implement the PipeTransform interface and define a transform method.

2. Step 2: Check each option

   export class MyPipe implements PipeTransform { transform(value: any): any { return value; } } correctly implements PipeTransform and has transform method. export class MyPipe { transform(value: any): any { return value; } } misses interface. export function MyPipe(value: any): any { return value; } is a function, not a class. export class MyPipe implements OnInit { transform(value: any): any { return value; } } wrongly implements OnInit instead of PipeTransform.

3. Final Answer:

   export class MyPipe implements PipeTransform { transform(value: any): any { return value; } } -> Option A

4. Quick Check:

   Pipe class implements PipeTransform [OK]

Hint: Custom pipes must implement PipeTransform interface [OK]

Common Mistakes:

• Forgetting to implement PipeTransform
• Using a function instead of a class
• Implementing wrong interfaces like OnInit

3. Given this custom pipe code, what will be the output of {{ 'hello' | exclaim }} if the pipe is defined as:

import { Pipe, PipeTransform } from '@angular/core';
@Pipe({ name: 'exclaim' })
export class ExclaimPipe implements PipeTransform {
  transform(value: string): string {
    return value + '!';
  }
}

medium

A. Error: Pipe not found

B. hello

C. hello!

D. !hello

Solution

1. Step 1: Understand the transform method behavior

   The transform method appends an exclamation mark to the input string.

2. Step 2: Apply the pipe to the input 'hello'

   Input 'hello' becomes 'hello!' after transformation.

3. Final Answer:

   hello! -> Option C

4. Quick Check:

   Input + '!' = hello! [OK]

Hint: transform method output is what pipe shows [OK]

Common Mistakes:

• Ignoring the transform method logic
• Assuming pipe adds prefix instead of suffix
• Not registering the pipe in module (causing errors)

4. What is wrong with this custom pipe code?

import { Pipe, PipeTransform } from '@angular/core';
@Pipe({ name: 'reverse' })
export class ReversePipe {
  transform(value: string): string {
    return value.split('').reverse().join('');
  }
}

medium

A. The class does not implement PipeTransform interface

B. The transform method is missing

C. The pipe name is invalid

D. The split method cannot be used on strings

Solution

1. Step 1: Check class declaration

   The class ReversePipe does not implement PipeTransform interface, which is required for custom pipes.

2. Step 2: Verify transform method presence

   The transform method exists and is correctly implemented.

3. Final Answer:

   The class does not implement PipeTransform interface -> Option A

4. Quick Check:

   Pipe class must implement PipeTransform [OK]

Hint: Always implement PipeTransform for custom pipes [OK]

Common Mistakes:

• Omitting PipeTransform interface
• Misnaming the transform method
• Incorrect pipe decorator usage

5. You want to create a custom pipe that formats a number to show 'Even' if the number is even, 'Odd' if odd, and 'Zero' if zero. Which transform method implementation is correct?

hard

A. transform(value: number): string { return value % 2 === 0 ? 'Even' : 'Odd'; }

B. transform(value: number): string { if (value === 0) return 'Zero'; return value % 2 === 0 ? 'Even' : 'Odd'; }

C. transform(value: number): string { if (value === 0) return 'Odd'; else return 'Even'; }

D. transform(value: number): string { if (value) return 'Even'; else return 'Zero'; }

Solution

1. Step 1: Handle zero case explicitly

   Zero is a special case and must return 'Zero'.

2. Step 2: Check even or odd for other numbers

   Use modulo operator to check if number is even or odd and return accordingly.

3. Final Answer:

   transform(value: number): string { if (value === 0) return 'Zero'; return value % 2 === 0 ? 'Even' : 'Odd'; } -> Option B

4. Quick Check:

   Zero check first, then even/odd [OK]

Hint: Check zero before even/odd to avoid wrong output [OK]

Common Mistakes:

• Not handling zero separately
• Returning wrong labels for zero
• Using incorrect conditions for even/odd