Validation

This guide explains how to validate the user input for your app using the validation plugin. The plugin gives you enough flexibility to write your own rules rather than being tied to any external validation library.

Here's what you'll learn...

• How to register and customize the plugin

• How to define the validation rules

• How to validate the data

• How to apply model-based validation rules

Note If you have already used the aurelia-validation plugin previously and are migrating your existing Aurelia app to Aurelia vNext then jump straight to the migration guide.

Install and register the plugin

You need to install two packages to use Aurelia validation. The core validation plugin @aurelia/validation and an adapter. Currently, only one adapter is available for validating HTML-based applications.

Installation

npm i @aurelia/validation @aurelia/validation-html

Register

import { ValidationHtmlConfiguration } from '@aurelia/validation-html';
import Aurelia from 'aurelia';

Aurelia
  .register(ValidationHtmlConfiguration)
  .app(component)
  .start();

Quick rundown

To use the validation plugin, all you have to do is inject the validation controller as well as the validation rules object to register validation rules.

Typescript

import { newInstanceForScope, resolve } from '@aurelia/kernel';
import { IValidationRules } from '@aurelia/validation';
import { IValidationController } from '@aurelia/validation-html';

export class AwesomeComponent {
  private person: Person; // Let us assume that we want to validate instance of Person class
  public constructor(
    private validationController: IValidationController = resolve(newInstanceForScope(IValidationController)),
    validationRules: IValidationRules = resolve(IValidationRules)
  ) {
    this.person = new Person();

    validationRules
      .on(this.person)
      .ensure('name')
        .required()
      .ensure('age')
        .required()
        .min(42);
  }

  public async submit() {
    const result = await this.validationController.validate();
    if(result.valid) {
      // Yay!! make that fetch now
    }
  }
}

Javascript

Inside our HTML, we use the validate binding behavior to signal to Aurelia that we want to validate these bindings. You might notice that both name and age appear in our view model above where we set some rules up.

<form submit.trigger="submit()">
  <input value.bind="person.name & validate">
  <input value.bind="person.age & validate">
</form>

resolve(newInstanceForScope(IValidationController)) injects a new instance of validation controller which is made available to the children of awesome-component. More on the controller is covered here.

Looking for end-to-end scenarios? Jump to the validation outcome recipes for step-by-step patterns such as inline feedback, guarded wizards, and server-error integration.

Demo

A playable demo can be seen below if you want to see the validation plugin in action. You can try adding new properties and playing around with the code to learn how to use the validation plugin.