Angular Form Validation

, , angular.js, javascript

In this article, we will describe some useful scripts and directives we use with angular form validation in our projects.

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.

    <!-- component template -->
    <form name="testForm">
        <input type="text" name="field1" ng-model="obj.field1" required>

        <div ng-messages="testForm.field1.$error" ng-messages-include="messages.html" ng-show="testForm.field1.$dirty"></div>

        <button type="submit">Send</button>
    </form>
    <!-- messages.html -->
    Field is required.

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:

    app.service("formValidation", ->
        setDirtyField = (field) ->
            # set $dirty property for the field
            field.$setDirty()

        localValidateForm: (form) ->
            # angular form validate
            # there can be nested forms therefore we should repeat the action recursively
            _formValidate = (innerForm) ->
                # check every form attribute angular.forEach
                angular.forEach innerForm, (field, name) ->
                    # check if current attribute is a control or nested form
                    # in this case attribute name doesn’t have “$” in the beginning
                    if angular.isString(name) and !name.match('^[\$]')
                        setDirtyField field
                        # check if attribute has method $setViewValue
                        # this allows to identify whether it is a control or a nested form
                        # if there’s no $setViewValue method then this is a nested form
                        if not angular.isFunction(field.$setViewValue)
                            _formValidate field
            _formValidate form
            return

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:

app.directive('submit', ['$parse', 'formValidation', ($parse, formValidation) ->
        restrict: 'A'
        link: (scope, formElement, attrs) ->
            # link to Submit action of the form
            formElement.bind 'submit', (e) ->
                # get the form from current element
                form = scope[attrs.name] or scope.$eval(attrs.name) or scope.$eval(attrs.ngForm)
                # stops submit action
                e.preventDefault()
                # sets $dirty with our service
                formValidation.localValidateForm form
                # call $digest loop to watch errors
                scope.$apply()
                if form.$valid
                    # call handler that we passes to the function
                    fn = $parse(attrs.submit)
                    scope.$apply(-> fn(scope, {$event: e}))
                return
    ])

An example:

    <form name="testForm" submit="submitForm()">
        <input type="text" name="field1" ng-model="obj.field1" required>
        <div ng-messages="testForm.field1.$error" ng-messages-include="messages.html" ng-show="testForm.field1.$dirty"></div>
        <button type="submit">Send</button>
    </form>

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.


    // Requirements declaration:
    var constraints = {
        username: { presence: true },
        password: {
            presence: true,
            length: {
                minimum: 6,
                message: "must be at least 6 characters"
            }
        }
    }

    // Validation example:

    validate({password: "bad"}, constraints);
    // => {
    //   "username": ["Username can't be blank"],
    //   "password": ["Password must be at least 6 characters"]
    // }

    // Validation of single value:
    validate.single("foo", {presence: true, email: true});
    // => ["is not a valid email"]

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:

    <div ng-controller="TestCtrl as $ctrl">
        <button type="button" ng-click="$ctrl.checkData()">Check data</button>
        <form name="$ctrl.testForm" submit="$ctrl.submitForm()" ng-if="$ctrl.showTestForm">
            <input type="text" name="field1" ng-model="$ctrl.obj.field1" required>
            <div ng-messages="testForm.field1.$error" ng-messages-include="messages.html" ng-show="$ctrl.testForm.field1.$dirty"></div>
            <button type="submit">Send</button>
        </form>
    </div>
#Controller
    app.controller('TestCtrl', ['$timeout', 'formValidation', ($timeout, formValidation) ->
        ctrl = @
        ctrl.obj = {field1: ''}
        ctrl.showTestForm = false
        # requirements for the form
        constraints = field1: { presence: true }
        ctrl.checkData = ->
            # validation
            if validate(ctrl.obj, constraints)
                # if values are invalid then show form and errors
                ctrl.showTestForm = true
                # timeout is necessary as the form controller is not available right away
                $timeout((-> formValidation.localValidateForm(ctrl.testForm)), 0)
            return

        ctrl.submitForm = ->
            alert('Data ' + ctrl.obj.field1)
            return
        return
    ])

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

contact us right now