Skip to content

Commit

Permalink
fix(ngAnimate): defer DOM operations for changing classes to postDigest
Browse files Browse the repository at this point in the history
When ngAnimate is used, it will defer changes to classes until postDigest. Previously,
AngularJS (when ngAnimate is not loaded) would always immediately perform these DOM
operations.

Now, even when the ngAnimate module is not used, if $rootScope is in the midst of a
digest, class manipulation is deferred. This helps reduce jank in browsers such as
IE11.

Closes angular#8234
Closes angular#9263
  • Loading branch information
caitp committed Oct 8, 2014
1 parent 3dea4a3 commit c5a060f
Show file tree
Hide file tree
Showing 4 changed files with 388 additions and 7 deletions.
108 changes: 104 additions & 4 deletions src/ng/animate.js
Expand Up @@ -81,9 +81,69 @@ var $AnimateProvider = ['$provide', function($provide) {
return this.$$classNameFilter;
};

this.$get = ['$$q', '$$asyncCallback', function($$q, $$asyncCallback) {
this.$get = ['$$q', '$$asyncCallback', '$rootScope', function($$q, $$asyncCallback, $rootScope) {

var currentDefer;
var ELEMENT_NODE = 1;

function extractElementNodes(element) {
var elements = new Array(element.length);
var count = 0;
for(var i = 0; i < element.length; i++) {
var elm = element[i];
if (elm.nodeType == ELEMENT_NODE) {
elements[count++] = elm;
}
}
elements.length = count;
return jqLite(elements);
}

function runAnimationPostDigest(fn) {
var cancelFn, defer = $$q.defer();
if (!$rootScope.$$phase) {
fn(noop);
defer.resolve();
}
defer.promise.$$cancelFn = function ngAnimateMaybeCancel() {
cancelFn && cancelFn();
};
$rootScope.$$postDigest(function ngAnimatePostDigest() {
cancelFn = fn(function ngAnimateNotifyComplete() {
defer.resolve();
});
});
return defer.promise;
}

function resolveElementClasses(element, cache) {
var map = {};

forEach(cache.add, function(className) {
if (className && className.length) {
map[className] = map[className] || 0;
map[className]++;
}
});

forEach(cache.remove, function(className) {
if (className && className.length) {
map[className] = map[className] || 0;
map[className]--;
}
});

var toAdd = [], toRemove = [];
forEach(map, function(status, className) {
var hasClass = jqLiteHasClass(element[0], className);

if (status < 0 && hasClass) toRemove.push(className);
else if (status > 0 && !hasClass) toAdd.push(className);
});

return (toAdd.length + toRemove.length) > 0 && [toAdd.join(' '), toRemove.join(' ')];
}

function asyncPromise() {
// only serve one instance of a promise in order to save CPU cycles
if (!currentDefer) {
Expand Down Expand Up @@ -187,6 +247,11 @@ var $AnimateProvider = ['$provide', function($provide) {
* @return {Promise} the animation callback promise
*/
addClass : function(element, className) {
return this.setClass(element, className, []);
},

$$addClassImmediately : function addClassImmediately(element, className) {
element = jqLite(element);
className = !isString(className)
? (isArray(className) ? className.join(' ') : '')
: className;
Expand All @@ -209,6 +274,11 @@ var $AnimateProvider = ['$provide', function($provide) {
* @return {Promise} the animation callback promise
*/
removeClass : function(element, className) {
return this.setClass(element, [], className);
},

$$removeClassImmediately : function removeClassImmediately(element, className) {
element = jqLite(element);
className = !isString(className)
? (isArray(className) ? className.join(' ') : '')
: className;
Expand All @@ -232,9 +302,39 @@ var $AnimateProvider = ['$provide', function($provide) {
* @return {Promise} the animation callback promise
*/
setClass : function(element, add, remove) {
this.addClass(element, add);
this.removeClass(element, remove);
return asyncPromise();
var self = this;
var STORAGE_KEY = '$$animateClasses';
element = extractElementNodes(jqLite(element));

add = isArray(add) ? add : add.split(' ');
remove = isArray(remove) ? remove : remove.split(' ');

var cache = element.data(STORAGE_KEY);
if (cache) {
cache.add = cache.add.concat(add);
cache.remove = cache.remove.concat(remove);
//the digest cycle will combine all the animations into one function
return cache.promise;
} else {
element.data(STORAGE_KEY, cache = {
add : add,
remove : remove
});
}

return cache.promise = runAnimationPostDigest(function(done) {
var cache = element.data(STORAGE_KEY);
element.removeData(STORAGE_KEY);

var classes = cache && resolveElementClasses(element, cache);

if (classes) {
if (classes[0].length) self.$$addClassImmediately(element, classes[0]);
if (classes[1].length) self.$$removeClassImmediately(element, classes[1]);
}

done();
});
},

enabled : noop,
Expand Down
9 changes: 6 additions & 3 deletions src/ngAnimate/animate.js
Expand Up @@ -979,7 +979,9 @@ angular.module('ngAnimate', ['ng'])
element = stripCommentsFromElement(element);

if (classBasedAnimationsBlocked(element)) {
return $delegate.setClass(element, add, remove);
if (add) $delegate.$$addClassImmediately(element, add);
if (remove) $delegate.$$removeClassImmediately(element, remove);
return;
}

// we're using a combined array for both the add and remove
Expand Down Expand Up @@ -1032,8 +1034,9 @@ angular.module('ngAnimate', ['ng'])
var classes = resolveElementClasses(element, cache, state.active);
return !classes
? done()
: performAnimation('setClass', classes, element, parentElement, null, function() {
$delegate.setClass(element, classes[0], classes[1]);
: performAnimation('setClass', classes, element, null, null, function() {
if (classes[0]) $delegate.$$addClassImmediately(element, classes[0]);
if (classes[1]) $delegate.$$removeClassImmediately(element, classes[1]);
}, done);
});
},
Expand Down

0 comments on commit c5a060f

Please sign in to comment.