AngularJS: API: ng/directive/ngModelOptions


ngModelOptions

  1. - directive in module ng

Allows tuning how model updates are done. Using ngModelOptions you can specify a custom list of events that will trigger a model update and/or a debouncing delay so that the actual update only takes place when a timer expires; this timer will be reset after another change takes place.

Given the nature of ngModelOptions, the value displayed inside input fields in the view might be different than the value in the actual model. This means that if you update the model you should also invoke $rollbackViewValue on the relevant input field in order to make sure it is synchronized with the model and that any debounced action is canceled.

The easiest way to reference the control's $rollbackViewValue method is by making sure the input is placed inside a form that has a name attribute. This is important because form controllers are published to the related scope under the name in their name attribute.

Any pending changes will take place immediately when an enclosing form is submitted via the submit event. Note that ngClick events will occur before the model is updated. Use ngSubmit to have access to the updated model.

Directive Info

  • This directive executes at priority level 0.

Usage

  • as attribute: 
    <ANY
  ng-model-options="">
...
</ANY>

Arguments

ParamTypeDetails
ngModelOptionsObject

options to apply to the current model. Valid keys are:

  • updateOn: string specifying which event should be the input bound to. You can set several events using an space delimited list. There is a special event called default that matches the default events belonging of the control.
  • debounce: integer value which contains the debounce model update value in milliseconds. A value of 0 triggers an immediate update. If an object is supplied instead, you can specify a custom value for each event. For example: ngModelOptions="{ updateOn: 'default blur', debounce: {'default': 500, 'blur': 0} }"
  • getterSetter: boolean value which determines whether or not to treat functions bound to ngModel as getters/setters.

Example

The following example shows how to override immediate updates. Changes on the inputs within the form will update the model only when the control loses focus (blur event). If escape key is pressed while the input field is focused, the value is reset to the value in the current model.

index.html
<div ng-controller="ExampleController">
  <form name="userForm">
    Name:
    <input type="text" name="userName"
           ng-model="user.name"
           ng-model-options="{ updateOn: 'blur' }"
           ng-keyup="cancel($event)" /><br />

    Other data:
    <input type="text" ng-model="user.data" /><br />
  </form>
  <pre>user.name = <span ng-bind="user.name"></span></pre></div>
app.js
angular.module('optionsExample', [])
  .controller('ExampleController', ['$scope', function($scope) {
    $scope.user = { name: 'say', data: '' };

    $scope.cancel = function (e) {
      if (e.keyCode == 27) {
        $scope.userForm.userName.$rollbackViewValue();
      }
    };
  }]);
protractor.js
var model = element(by.binding('user.name'));var input = element(by.model('user.name'));var other = element(by.model('user.data'));

it('should allow custom events', function() {
  input.sendKeys(' hello');
  input.click();
  expect(model.getText()).toEqual('say');
  other.click();
  expect(model.getText()).toEqual('say hello');});

it('should $rollbackViewValue when model changes', function() {
  input.sendKeys(' hello');
  expect(input.getAttribute('value')).toEqual('say hello');
  input.sendKeys(protractor.Key.ESCAPE);
  expect(input.getAttribute('value')).toEqual('say');
  other.click();
  expect(model.getText()).toEqual('say');});

This one shows how to debounce model changes. Model will be updated only 1 sec after last change. If the Clear button is pressed, any debounced action is canceled and the value becomes empty.

index.html
<div ng-controller="ExampleController">
  <form name="userForm">
    Name:
    <input type="text" name="userName"
           ng-model="user.name"
           ng-model-options="{ debounce: 1000 }" />
    <button ng-click="userForm.userName.$rollbackViewValue(); user.name=''">Clear</button><br />
  </form>
  <pre>user.name = <span ng-bind="user.name"></span></pre></div>
app.js
angular.module('optionsExample', [])
  .controller('ExampleController', ['$scope', function($scope) {
    $scope.user = { name: 'say' };
  }]);

This one shows how to bind to getter/setters:

index.html
<div ng-controller="ExampleController">
  <form name="userForm">
    Name:
    <input type="text" name="userName"
           ng-model="user.name"
           ng-model-options="{ getterSetter: true }" />
  </form>
  <pre>user.name = <span ng-bind="user.name()"></span></pre></div>
app.js
angular.module('getterSetterExample', [])
  .controller('ExampleController', ['$scope', function($scope) {
    var _name = 'Brian';
    $scope.user = {
      name: function (newName) {
        return angular.isDefined(newName) ? (_name = newName) : _name;
      }
    };
  }]);