Made JS animation cleanup process more reliable

Fixes #1643
This commit is contained in:
Dan Brown
2019-10-07 20:57:25 +01:00
parent b6c0baf44d
commit d4c62265ca

View File

@ -1,3 +1,10 @@
/**
* Used in the function below to store references of clean-up functions.
* Used to ensure only one transitionend function exists at any time.
* @type {WeakMap<object, any>}
*/
const animateStylesCleanupMap = new WeakMap();
/** /**
* Fade out the given element. * Fade out the given element.
* @param {Element} element * @param {Element} element
@ -5,6 +12,7 @@
* @param {Function|null} onComplete * @param {Function|null} onComplete
*/ */
export function fadeOut(element, animTime = 400, onComplete = null) { export function fadeOut(element, animTime = 400, onComplete = null) {
cleanupExistingElementAnimation(element);
animateStyles(element, { animateStyles(element, {
opacity: ['1', '0'] opacity: ['1', '0']
}, animTime, () => { }, animTime, () => {
@ -19,6 +27,7 @@ export function fadeOut(element, animTime = 400, onComplete = null) {
* @param {Number} animTime * @param {Number} animTime
*/ */
export function slideUp(element, animTime = 400) { export function slideUp(element, animTime = 400) {
cleanupExistingElementAnimation(element);
const currentHeight = element.getBoundingClientRect().height; const currentHeight = element.getBoundingClientRect().height;
const computedStyles = getComputedStyle(element); const computedStyles = getComputedStyle(element);
const currentPaddingTop = computedStyles.getPropertyValue('padding-top'); const currentPaddingTop = computedStyles.getPropertyValue('padding-top');
@ -41,6 +50,7 @@ export function slideUp(element, animTime = 400) {
* @param {Number} animTime - Animation time in ms * @param {Number} animTime - Animation time in ms
*/ */
export function slideDown(element, animTime = 400) { export function slideDown(element, animTime = 400) {
cleanupExistingElementAnimation(element);
element.style.display = 'block'; element.style.display = 'block';
const targetHeight = element.getBoundingClientRect().height; const targetHeight = element.getBoundingClientRect().height;
const computedStyles = getComputedStyle(element); const computedStyles = getComputedStyle(element);
@ -56,13 +66,6 @@ export function slideDown(element, animTime = 400) {
animateStyles(element, animStyles, animTime); animateStyles(element, animStyles, animTime);
} }
/**
* Used in the function below to store references of clean-up functions.
* Used to ensure only one transitionend function exists at any time.
* @type {WeakMap<object, any>}
*/
const animateStylesCleanupMap = new WeakMap();
/** /**
* Animate the css styles of an element using FLIP animation techniques. * Animate the css styles of an element using FLIP animation techniques.
* Styles must be an object where the keys are style properties, camelcase, and the values * Styles must be an object where the keys are style properties, camelcase, and the values
@ -84,23 +87,28 @@ function animateStyles(element, styles, animTime = 400, onComplete = null) {
} }
element.style.transition = null; element.style.transition = null;
element.removeEventListener('transitionend', cleanup); element.removeEventListener('transitionend', cleanup);
animateStylesCleanupMap.delete(element);
if (onComplete) onComplete(); if (onComplete) onComplete();
}; };
setTimeout(() => { setTimeout(() => {
requestAnimationFrame(() => { element.style.transition = `all ease-in-out ${animTime}ms`;
element.style.transition = `all ease-in-out ${animTime}ms`; for (let style of styleNames) {
for (let style of styleNames) { element.style[style] = styles[style][1];
element.style[style] = styles[style][1]; }
}
if (animateStylesCleanupMap.has(element)) { element.addEventListener('transitionend', cleanup);
const oldCleanup = animateStylesCleanupMap.get(element); animateStylesCleanupMap.set(element, cleanup);
element.removeEventListener('transitionend', oldCleanup); }, 15);
} }
element.addEventListener('transitionend', cleanup); /**
animateStylesCleanupMap.set(element, cleanup); * Run the active cleanup action for the given element.
}); * @param {Element} element
}, 10); */
function cleanupExistingElementAnimation(element) {
if (animateStylesCleanupMap.has(element)) {
const oldCleanup = animateStylesCleanupMap.get(element);
oldCleanup();
}
} }