Back
Sep 22, 2016

Angular Form Validation

Igor Tokarev

Display errors after edit

One of the key features of form validation in Angular is an error displaying. When we create a form in view template, Angular creates a controller for the form. This controller contains controls and nested forms with controls statuses (valid/invalid), errors etc.

The default behavior of controller is to set errors for controls with invalid values immediately when the form is displayed. F.e. a form with some mandatory fields was loaded on a web page and these fields are empty by default, the form is waiting for user data. The controller sets errors for these mandatory fields because no value is also an invalid value. But it’s better to show these errors to user only on their actions like field editing or trying to send/save data, not at once an empty form was shown.

To display errors we use a combination of control states: $dirty && $invalid, where $dirty means control data was changed by user, $invalid indicates that the model has invalid values.

false
false

In this example, we use only one directive “required” to check if the field is filled, and ngMessages module to display errors. However, the form displays an error only if field1 was edited by user: ng-show="testForm.field1.$dirty". This means if a user clicks Send button right away with no data inputted to the form, there won’t be any error shown. It’s necessary to set property $dirty for the control, we use $setDirty() method for this.

Here’s a small service to set this property:

false

This is how the service can be used: formValidation.localValidateForm(scope.testForm). For convenience of use I created a directive which sets property $dirty on Submit action to all form fields and calls event handler if the form is valid:

false

An example:

false

On Send button click the testForm will show errors in case of invalid data, otherwise, action submitForm() will be called.

There are some issues with form validation in Angular 1. The entire validation system is based on rendered input fields and this leads to next disadvantages:

  • We can’t reuse validation without view render. We got this issue in one of our projects, where we needed to validate data stored in the controller and there was no possibility to display form template. We had to duplicate validation in the controller to solve the problem.
  • A complexity of tests. Developers have to use end-to-end tests.

Angular form validation in controller

Below I describe validation solution with use of Angular 1. In the example I use a small library for data validation - validatejs. This library provides a declarative way to validate js objects.

false

The validation function returns a list of errors for invalid data and undefined for valid data.

The library has several stock validators like DateTime, Email, Equality, Length, URL etc, and you can add your custom one. After checking the form with validatejs we display it and call formValidation.localValidateForm(testForm) to show errors.

Example with the same form:

false
false

The form is not displayed in this example because ng-if condition is not satisfied. On Check button click I call function ctrl.checkData in the controller to validate our values, and if they are invalid the function returns a list of errors.

Demo: https://codepen.io/anon/pen/gwAjBR

More thoughts