$watch How the $apply Runs a $digest

1
2

User: <input type="text" ng-model="user" /> Password: "password" "pass" /> 

app.controller('MainCtrl', function($scope) {  $scope.foo = "Foo";  world = "World"; }); 

Hello,{{ World }} 

Here,even though we have two things attached to the$scope,only one is bound. So in this case we only created one$watch.

people = [...]; }); 

<ul>  <li ng-repeat="person in people">  {{person.name}} - {{person.age}}  </li> </ul> 

How many$watchare created here? Two for each person (for name and age) in people plus one for theng-repeat. If we have 10 people in the list it will be(2 * 10) + 1,AKA21$watch.

So,everything that is bound in our UI using directives creates a$watch. Right,but when are those$watchcreated?

When our template is loaded,AKA in thelinking phase,the compiler will look for every directive and creates all the$watchthat are needed. This sounds good,but… now what?

$digest loop

Remember the extendedevent-loopI talked about? When the browser receives an event that can be managed by theangular contextthe$digestloop will be fired. This loop is made from two smaller loops. One processes the$evalAsyncqueue and the other one processes the$watchlist,which is the subject of this article.

What is that process about? The$digestwill loop through the list of$watchthat we have,asking this:

• Hey
• It is9

This is thedirty-checking. Now that all the$watchhave been checked there is something else to ask: Is there any$watchthat has been updated? If there is at least one of them that has changed,the loop will fire again until all of the$watchreport no changes. This is to ensure that every model is clean. Have in mind that if the loop runs more than 10 times,it will throw an exception to prevent infinite loops.

When the$digest loopfinishes,the DOM makes the changes.

Example:

function() {  name = "Foo";   changeFoo = "Bar";  } }); 

Here we have only one$watchbecause ng-click doesn’t create any watches (the function is not going to change :P).

• We press the button.
• The browser receives an event which will enter theangular context(I will explain why,later in this article).
• The$digest loopwill run and will ask every$watchfor changes.
• Since the$watchwhich was watching for changes in$scope.namereports a change,if will force another $digest loop.
• The new loop reports nothing.
• The browser gets the control back and it will update the DOM reflecting the new value of$scope.name

The important thing here (which is seen as a pain-point by many people) is that EVERY event that enters theangular contextwill run a$digest loop. That means that every time we write a letter in an input,the loop will run checking every$watchin this page.

Entering the angular context with $apply

What says which events enter the angular context and which ones do not?$apply

If you call$applywhen an event is fired,it will go through theangular-context,but if you don’t call it,it will run outside it. It is as easy as that. So you may now ask… That last example does work and I haven’t calledng-click,the event will be wrapped inside an$applycall. If you have an input withng-model="foo"and you write anf,the event will be called like this:$apply("foo = 'f';"),in other words,wrapped in an$applycall.

When angular doesn’t use $apply for us

This is the common pain-point for newcomers to Angular. Why is my jQuery not updating my bindings? Because jQuery doesn’t call$applyand then the events never enter theangular contextand then the$digest loopis never fired.

Let’s see an interesting example:

Imagine we have the following directive and controller:

directive('clickable',210)!important">function() {  return {  restrict: "E",  scope: {  foo: '=',0)!important">bar: '='  },0)!important">template: '<ul style="background-color: lightblue"><li>{{foo}}</li><li>{{bar}}</li></ul>',0)!important">link: scope, element,0)!important">attrs) {  element.bind('click',0)!important">scope.foo++;  bar++;  });  } }  });  foo = 0;  bar = 0; }); 

It bindsfooandbarfrom the controller to show them in a list,then every time we click on the element,bothbarvalues are incremented by one.

What will happen if we click on the element? Are we going to see the updates? The answer is no. No,because theclickevent is a common event that is not wrapped into an$applycall. So that means that we are going to lose our count? No.

What is happening is that the$scopeis indeed changing but since that is not forcing a$digest loop,the$watchforfooand the one forbarare not running,so they are not aware of the changes. This also means that if we do something else that does run an$watchwe have will see that they have changed and then update the DOM as needed.

Try it

If we click on the directive (the blue zone) we won’t see any changes,but if we click on the button to update the string next to it,we suddenly see how many times we clicked on the directive. Just what I said,the clicks on the directive won’t trigger any$digest loopbut when the button is clicked on,monospace; font-size:0.8em; vertical-align:baseline; display:inline-block">ng-clickwill call$applyand it will run the$watchwe have are going to be checked for changes,and that includes the one forbar.

Now you are thinking that this is not what you want,you want to update the bindings as soon as you click on the directive. That is easy,we just need to call$applylike this:

bar++;   $apply(); }); 

$applyis a function of our$scope(orscopeinside a directive’s link function) so calling it will force a$digest loop(except if there is a loop in course,in that case it will throw an exception,which is a sign that we don’t need to call$applythere).

Try it

It works! But there is a better way for using$apply:

What’s the difference? The difference is that in the first version,we are updating the values outside theangular contextso if that throws an error,Angular will never know. Obviously in this tiny toy example it won’t make much difference,but imagine that we have an alert box to show errors to our users and we have a 3rd party library that does a network call and it fails. If we don’t wrap it inside an So if you want to use a jQuery plugin,be sure you call$applyif you need to run a$digest loopto update your DOM.

"Angular";   updated = -1;   $watch('name',0)!important">updated++;  }); }); 

updated = 0;   newValue,0)!important">oldValue) {  if (newValue === oldValue) { return; } // AKA first run  </body>