This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The animationcancel
event is fired when a CSS Animation unexpectedly aborts. In other words, any time it stops running without sending an animationend
event. This might happen when the animation-name
is changed such that the animation is removed, or when the animating node is hidden using CSS. Therefore, either directly or because any of its containing nodes are hidden.
An event handler for this event can be added by setting the onanimationcancel
property, or using addEventListener()
.
Bubbles | Yes |
---|---|
Cancelable | No |
Interface | AnimationEvent |
Event handler property | onanimationcancel |
Examples
This code gets an element that's currently being animated and adds a listener to the animationcancel
event. It then sets the element's display
property to none
, which will trigger the animationcancel
event.
const animated = document.querySelector('.animated'); animated.addEventListener('animationcancel', () => { console.log('Animation canceled'); }); animated.style.display = 'none';
The same, but using the onanimationcancel
property instead of addEventListener()
:
const animated = document.querySelector('.animated'); animated.onanimationcancel = () => { console.log('Animation canceled'); }; animated.style.display = 'none';
Live example
HTML
<div class="animation-example"> <div class="container"> <p class="animation">You chose a cold night to visit our planet.</p> </div> <button class="activate" type="button">Activate animation</button> <div class="event-log"></div> </div>
CSS
.container { height: 3rem; } .event-log { width: 25rem; height: 2rem; border: 1px solid black; margin: 0.2rem; padding: 0.2rem; } .animation.active { animation-duration: 2s; animation-name: slidein; animation-iteration-count: 2; } @keyframes slidein { from { transform: translateX(100%) scaleX(3); } to { transform: translateX(0) scaleX(1); } }
JS
const animation = document.querySelector('p.animation'); const animationEventLog = document.querySelector('.animation-example>.event-log'); const applyAnimation = document.querySelector('.animation-example>button.activate'); let iterationCount = 0; animation.addEventListener('animationstart', () => { animationEventLog.textContent = `${animationEventLog.textContent}'animation started' `; }); animation.addEventListener('animationiteration', () => { iterationCount++; animationEventLog.textContent = `${animationEventLog.textContent}'animation iterations: ${iterationCount}' `; }); animation.addEventListener('animationend', () => { animationEventLog.textContent = `${animationEventLog.textContent}'animation ended'`; animation.classList.remove('active'); applyAnimation.textContent = "Activate animation"; }); animation.addEventListener('animationcancel', () => { animationEventLog.textContent = `${animationEventLog.textContent}'animation canceled'`; }); applyAnimation.addEventListener('click', () => { animation.classList.toggle('active'); animationEventLog.textContent = ''; iterationCount = 0; let active = animation.classList.contains('active'); if (active) { applyAnimation.textContent = "Cancel animation"; } else { applyAnimation.textContent = "Activate animation"; } });
Result
Specifications
Specification | Status | Comment |
---|---|---|
CSS Animations | Working Draft | Initial definition |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
animationcancel event | Chrome No support No | Edge No support No | Firefox Full support 54 | IE No support No | Opera No support No | Safari
Full support
13.1
| WebView Android No support No | Chrome Android No support No | Firefox Android Full support 54 | Opera Android No support No | Safari iOS
Full support
13.4
| Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- User must explicitly enable this feature.
- User must explicitly enable this feature.
See also
- CSS Animations
- Using CSS Animations
AnimationEvent
- Related events:
animationstart
,animationend
,animationiteration
- This event on
Document
targets:animationcancel
- This event on
Window
targets:animationcancel