Skip to content

Commit

Permalink
fix($animate): skip ngAnimate animations if the provided element alre…
Browse files Browse the repository at this point in the history 
…ady has transitions/durations attached to it

Closes angular#3587
  • Loading branch information
@matsko @jamesdaily
matsko authored and jamesdaily committed Jan 27, 2014
1 parent e5f7f87 commit 443ed70
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 52 deletions.
7 changes: 0 additions & 7 deletions docs/src/templates/css/animations.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,6 @@
height:0;
}

.animate-container.animations-off * {
-webkit-transition: none;
-moz-transition: none;
-o-transition: color 0 ease-in; /* opera is special :) */
transition: none;
}

.foldout.ng-enter,
.foldout.ng-hide-add,
.foldout.ng-hide-remove {
Expand Down
10 changes: 9 additions & 1 deletion src/ng/directive/ngClass.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ function classDirective(name, selector) {
## Animations
Example that demostrates how addition and removal of classes can be animated.
The example below demonstrates how to perform animations using ngClass.
<example animations="true">
<file name="index.html">
Expand Down Expand Up @@ -196,6 +196,14 @@ function classDirective(name, selector) {
});
</file>
</example>
## ngClass and pre-existing CSS3 Transitions/Animations
The ngClass directive still supports CSS3 Transitions/Animations even if they do not follow the ngAnimate CSS naming structure.
Therefore, if any CSS3 Transition/Animation styles (outside of ngAnimate) are set on the element, then, if a ngClass animation
is triggered, the ngClass animation will be skipped so that ngAnimate can allow for the pre-existing transition or animation to
take over. This restriction allows for ngClass to still work with standard CSS3 Transitions/Animations that are defined
outside of ngAnimate.
*/
var ngClassDirective = classDirective('', true);

Expand Down
98 changes: 54 additions & 44 deletions src/ngAnimate/animate.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,8 @@ angular.module('ngAnimate', ['ng'])
* |----------------------------------------------------------------------------------------------|-----------------------------------------------|
* | 1. $animate.enter(...) is called | class="my-animation" |
* | 2. element is inserted into the parent element or beside the after element | class="my-animation" |
* | 3. the .ng-enter class is added to the element | class="my-animation ng-enter" |
* | 4. $animate runs any JavaScript-defined animations on the element | class="my-animation ng-enter" |
* | 3. $animate runs any JavaScript-defined animations on the element | class="my-animation" |
* | 4. the .ng-enter class is added to the element | class="my-animation ng-enter" |
* | 5. $animate scans the element styles to get the CSS transition/animation duration and delay | class="my-animation ng-enter" |
* | 6. the .ng-enter-active class is added (this triggers the CSS transition/animation) | class="my-animation ng-enter ng-enter-active" |
* | 7. $animate waits for X milliseconds for the animation to complete | class="my-animation ng-enter ng-enter-active" |
Expand Down Expand Up @@ -302,8 +302,8 @@ angular.module('ngAnimate', ['ng'])
* | Animation Step | What the element class attribute looks like |
* |----------------------------------------------------------------------------------------------|----------------------------------------------|
* | 1. $animate.leave(...) is called | class="my-animation" |
* | 2. the .ng-leave class is added to the element | class="my-animation ng-leave" |
* | 3. $animate runs any JavaScript-defined animations on the element | class="my-animation ng-leave" |
* | 2. $animate runs any JavaScript-defined animations on the element | class="my-animation" |
* | 3. the .ng-leave class is added to the element | class="my-animation ng-leave" |
* | 4. $animate scans the element styles to get the CSS transition/animation duration and delay | class="my-animation ng-leave" |
* | 5. the .ng-leave-active class is added (this triggers the CSS transition/animation) | class="my-animation ng-leave ng-leave-active |
* | 6. $animate waits for X milliseconds for the animation to complete | class="my-animation ng-leave ng-leave-active |
Expand Down Expand Up @@ -337,8 +337,8 @@ angular.module('ngAnimate', ['ng'])
* |----------------------------------------------------------------------------------------------|---------------------------------------------|
* | 1. $animate.move(...) is called | class="my-animation" |
* | 2. element is moved into the parent element or beside the after element | class="my-animation" |
* | 3. the .ng-move class is added to the element | class="my-animation ng-move" |
* | 4. $animate runs any JavaScript-defined animations on the element | class="my-animation ng-move" |
* | 3. $animate runs any JavaScript-defined animations on the element | class="my-animation" |
* | 4. the .ng-move class is added to the element | class="my-animation ng-move" |
* | 5. $animate scans the element styles to get the CSS transition/animation duration and delay | class="my-animation ng-move" |
* | 6. the .ng-move-active class is added (this triggers the CSS transition/animation) | class="my-animation ng-move ng-move-active" |
* | 7. $animate waits for X milliseconds for the animation to complete | class="my-animation ng-move ng-move-active" |
Expand Down Expand Up @@ -373,8 +373,8 @@ angular.module('ngAnimate', ['ng'])
* | Animation Step | What the element class attribute looks like |
* |------------------------------------------------------------------------------------------------|---------------------------------------------|
* | 1. $animate.addClass(element, 'super') is called | class="" |
* | 2. the .super-add class is added to the element | class="super-add" |
* | 3. $animate runs any JavaScript-defined animations on the element | class="super-add" |
* | 2. $animate runs any JavaScript-defined animations on the element | class="" |
* | 3. the .super-add class is added to the element | class="super-add" |
* | 4. $animate scans the element styles to get the CSS transition/animation duration and delay | class="super-add" |
* | 5. the .super-add-active class is added (this triggers the CSS transition/animation) | class="super-add super-add-active" |
* | 6. $animate waits for X milliseconds for the animation to complete | class="super-add super-add-active" |
Expand Down Expand Up @@ -408,8 +408,8 @@ angular.module('ngAnimate', ['ng'])
* | Animation Step | What the element class attribute looks like |
* |-----------------------------------------------------------------------------------------------|-------------------------------------------------|
* | 1. $animate.removeClass(element, 'super') is called | class="super" |
* | 2. the .super-remove class is added to the element | class="super super-remove" |
* | 3. $animate runs any JavaScript-defined animations on the element | class="super super-remove" |
* | 2. $animate runs any JavaScript-defined animations on the element | class="super" |
* | 3. the .super-remove class is added to the element | class="super super-remove" |
* | 4. $animate scans the element styles to get the CSS transition/animation duration and delay | class="super super-remove" |
* | 5. the .super-remove-active class is added (this triggers the CSS transition/animation) | class="super super-remove super-remove-active" |
* | 6. $animate waits for X milliseconds for the animation to complete | class="super super-remove super-remove-active" |
Expand Down Expand Up @@ -494,23 +494,14 @@ angular.module('ngAnimate', ['ng'])
done:done
});

var baseClassName = className;
if(event == 'addClass') {
className = suffixClasses(className, '-add');
} else if(event == 'removeClass') {
className = suffixClasses(className, '-remove');
}

element.addClass(className);

forEach(animations, function(animation, index) {
var fn = function() {
progress(index);
};

if(animation.start) {
if(event == 'addClass' || event == 'removeClass') {
animation.endFn = animation.start(element, baseClassName, fn);
animation.endFn = animation.start(element, className, fn);
} else {
animation.endFn = animation.start(element, fn);
}
Expand Down Expand Up @@ -538,7 +529,6 @@ angular.module('ngAnimate', ['ng'])
function done() {
if(!done.hasBeenRun) {
done.hasBeenRun = true;
element.removeClass(className);
element.removeData(NG_ANIMATE_STATE);
(onComplete || noop)();
}
Expand All @@ -549,26 +539,45 @@ angular.module('ngAnimate', ['ng'])
$animateProvider.register('', ['$window','$sniffer', '$timeout', function($window, $sniffer, $timeout) {
var noop = angular.noop;
var forEach = angular.forEach;

//one day all browsers will have these properties
var w3cAnimationProp = 'animation';
var w3cTransitionProp = 'transition';

//but some still use vendor-prefixed styles
var vendorAnimationProp = $sniffer.vendorPrefix + 'Animation';
var vendorTransitionProp = $sniffer.vendorPrefix + 'Transition';

var durationKey = 'Duration',
delayKey = 'Delay',
animationIterationCountKey = 'IterationCount',
ELEMENT_NODE = 1;

function animate(element, className, done) {
if (!($sniffer.transitions || $sniffer.animations)) {
done();
return;
}
else if(['ng-enter','ng-leave','ng-move'].indexOf(className) == -1) {
var existingDuration = 0;
forEach(element, function(element) {
if (element.nodeType == ELEMENT_NODE) {
var elementStyles = $window.getComputedStyle(element) || {};
existingDuration = Math.max(parseMaxTime(elementStyles[w3cTransitionProp + durationKey]),
parseMaxTime(elementStyles[vendorTransitionProp + durationKey]),
existingDuration);
}
});
if(existingDuration > 0) {
done();
return;
}
}

//one day all browsers will have these properties
var w3cAnimationProp = 'animation';
var w3cTransitionProp = 'transition';

//but some still use vendor-prefixed styles
var vendorAnimationProp = $sniffer.vendorPrefix + 'Animation';
var vendorTransitionProp = $sniffer.vendorPrefix + 'Transition';

var durationKey = 'Duration',
delayKey = 'Delay',
animationIterationCountKey = 'IterationCount';
element.addClass(className);

//we want all the styles defined before and after
var duration = 0, ELEMENT_NODE = 1;
var duration = 0;
forEach(element, function(element) {
if (element.nodeType == ELEMENT_NODE) {
var elementStyles = $window.getComputedStyle(element) || {};
Expand Down Expand Up @@ -615,6 +624,7 @@ angular.module('ngAnimate', ['ng'])
//there is no need to attach this internally to the
//timeout done method
return function onEnd(cancelled) {
element.removeClass(className);
element.removeClass(activeClassName);

//only when the animation is cancelled is the done()
Expand All @@ -626,6 +636,7 @@ angular.module('ngAnimate', ['ng'])
}
}
else {
element.removeClass(className);
done();
}

Expand Down Expand Up @@ -656,16 +667,15 @@ angular.module('ngAnimate', ['ng'])
}
};

function suffixClasses(classes, suffix) {
var className = '';
classes = angular.isArray(classes) ? classes : classes.split(/\s+/);
forEach(classes, function(klass, i) {
if(klass && klass.length > 0) {
className += (i > 0 ? ' ' : '') + klass + suffix;
}
});
return className;
}
}]);

function suffixClasses(classes, suffix) {
var className = '';
classes = angular.isArray(classes) ? classes : classes.split(/\s+/);
forEach(classes, function(klass, i) {
if(klass && klass.length > 0) {
className += (i > 0 ? ' ' : '') + klass + suffix;
}
});
return className;
}
}]);
29 changes: 29 additions & 0 deletions test/ngAnimate/animateSpec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1584,4 +1584,33 @@ describe("ngAnimate", function() {
});
});

it("should skip ngAnimate animations when any pre-existing CSS transitions are present on the element", function() {
inject(function($compile, $rootScope, $animate, $timeout, $sniffer) {
if(!$sniffer.transitions) return;

var element = html($compile('<div class="animated parent"></div>')($rootScope));
var child = html($compile('<div class="animated child"></div>')($rootScope));

ss.addRule('.animated', 'transition:1s linear all;' +
vendorPrefix + 'transition:1s linear all');
ss.addRule('.super-add', 'transition:2s linear all;' +
vendorPrefix + 'transition:2s linear all');

$rootElement.append(element);
jqLite(document.body).append($rootElement);

$animate.addClass(element, 'super');
$timeout.flush(0);

var empty = true;
try {
$timeout.flush();
empty = false;
}
catch(e) {}

expect(empty).toBe(true);
});
});

});

0 comments on commit 443ed70

Please sign in to comment.