Angular’s form validation is pretty sweet, but sometimes you need to roll up your sleeves and create your own custom validators. It’s like adding a secret sauce to your forms – you get to decide exactly how things should be checked.
Let’s dive into the world of custom validators in Angular. Trust me, it’s not as scary as it sounds!
First things first, what’s a validator anyway? It’s just a function that checks if the data in a form control is valid. Angular comes with some built-in validators like required, minLength, and email. But what if you need something more specific? That’s where custom validators come in handy.
Say you’re building a registration form for a space travel agency (because why not?). You want to make sure the user’s chosen spaceship name is unique. Angular doesn’t have a built-in validator for that, so you’ll need to create your own.
Here’s how you might write a custom validator for our spaceship name:
import { AbstractControl, ValidationErrors, ValidatorFn } from '@angular/forms';
export function uniqueSpaceshipValidator(existingNames: string[]): ValidatorFn {
return (control: AbstractControl): ValidationErrors | null => {
const name = control.value;
if (existingNames.includes(name)) {
return { uniqueSpaceship: true };
}
return null;
};
}
This validator takes an array of existing spaceship names and returns a function. That function checks if the entered name is in the list of existing names. If it is, it returns an error object. If not, it returns null, meaning the validation passed.
Now, let’s use this validator in our component:
import { Component, OnInit } from '@angular/core';
import { FormBuilder, FormGroup, Validators } from '@angular/forms';
import { uniqueSpaceshipValidator } from './validators';
@Component({
selector: 'app-spaceship-registration',
template: `
<form [formGroup]="registrationForm" (ngSubmit)="onSubmit()">
<input formControlName="spaceshipName" placeholder="Spaceship Name">
<div *ngIf="registrationForm.get('spaceshipName').errors?.uniqueSpaceship">
This spaceship name is already taken!
</div>
<button type="submit">Register</button>
</form>
`
})
export class SpaceshipRegistrationComponent implements OnInit {
registrationForm: FormGroup;
existingNames = ['Enterprise', 'Millennium Falcon', 'Serenity'];
constructor(private fb: FormBuilder) {}
ngOnInit() {
this.registrationForm = this.fb.group({
spaceshipName: ['', [Validators.required, uniqueSpaceshipValidator(this.existingNames)]]
});
}
onSubmit() {
if (this.registrationForm.valid) {
console.log('Spaceship registered!');
}
}
}
Cool, right? We’ve just created a custom validator and used it in our form. Now our space travelers can’t accidentally register the same spaceship twice!
But wait, there’s more! What if we want to validate something asynchronously? Maybe we need to check with our space station database to see if the name is available. For that, we can create an async validator.
Here’s how an async validator might look:
import { AbstractControl, AsyncValidatorFn, ValidationErrors } from '@angular/forms';
import { Observable, of } from 'rxjs';
import { map, delay } from 'rxjs/operators';
export function asyncSpaceshipValidator(spaceshipService: SpaceshipService): AsyncValidatorFn {
return (control: AbstractControl): Observable<ValidationErrors | null> => {
const name = control.value;
// Simulate API call with delay
return of(name).pipe(
delay(1000),
map(name => {
// Check if name exists in the "database"
const exists = spaceshipService.checkNameExists(name);
return exists ? { spaceshipExists: true } : null;
})
);
};
}
This async validator simulates an API call to check if the spaceship name already exists. In a real-world scenario, you’d replace the delay and mock check with an actual HTTP request to your backend.
To use this async validator, you’d add it to your form control like this:
this.registrationForm = this.fb.group({
spaceshipName: ['',
[Validators.required],
[asyncSpaceshipValidator(this.spaceshipService)]
]
});
Now your form will show a loading indicator while it’s checking the name, and display an error if the name already exists in your space database.
Custom validators aren’t just for simple checks. They can be as complex as you need them to be. Want to make sure a password contains at least one number, one uppercase letter, one lowercase letter, and one special character? No problem! Here’s a validator for that:
export function strongPasswordValidator(): ValidatorFn {
return (control: AbstractControl): ValidationErrors | null => {
const value = control.value;
if (!value) {
return null; // Let required validator handle empty fields
}
const hasUpperCase = /[A-Z]+/.test(value);
const hasLowerCase = /[a-z]+/.test(value);
const hasNumeric = /[0-9]+/.test(value);
const hasSpecialChar = /[!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]+/.test(value);
const valid = hasUpperCase && hasLowerCase && hasNumeric && hasSpecialChar;
return valid ? null : { strongPassword: true };
};
}
This validator uses regular expressions to check for the presence of different types of characters. You could use it like this:
this.form = this.fb.group({
password: ['', [Validators.required, Validators.minLength(8), strongPasswordValidator()]]
});
Now your users will have super secure passwords for their space adventures!
Remember, the key to writing good custom validators is to keep them focused on a single task. If you find your validator doing too many things, it might be time to split it into multiple validators.
Custom validators are like your secret weapon in the Angular universe. They let you add that extra layer of data integrity to your forms, ensuring that the information you’re collecting is exactly what you need.
And here’s a pro tip: you can combine multiple validators using the Validators.compose method. This lets you create complex validation rules by combining simpler ones:
const passwordValidators = Validators.compose([
Validators.required,
Validators.minLength(8),
strongPasswordValidator()
]);
this.form = this.fb.group({
password: ['', passwordValidators]
});
Custom validators aren’t just useful for forms, either. You can use them anywhere you need to validate data in your Angular app. They’re great for validating input in dialogs, checking data before sending it to an API, or even validating configuration options in your app.
One last thing to keep in mind: always provide clear error messages for your custom validators. Users should know exactly why their input was rejected and how to fix it. In our spaceship name example, we could expand the error message to be more helpful:
<div *ngIf="registrationForm.get('spaceshipName').errors?.uniqueSpaceship">
This spaceship name is already registered. Please choose a different name for your vessel.
</div>
Custom validators in Angular are a powerful tool in your developer toolkit. They allow you to create exactly the validation rules your app needs, ensuring data integrity and improving user experience. Whether you’re building a space travel registration form or a more down-to-earth application, custom validators can help you keep your data clean and your users happy. So go forth and validate with confidence!