Animation: cancel event

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2020.

The cancel event of the Animation interface is fired when the Animation.cancel() method is called or when the animation enters the "idle" play state from another state, such as when the animation is removed from an element before it finishes playing.

Note: Creating a new animation that is initially idle does not trigger a cancel event on the new animation.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("cancel", (event) => { })
oncancel = (event) => { }

Event type

An AnimationPlaybackEvent. Inherits from Event.

Event AnimationPlaybackEvent

Event properties

In addition to the properties listed below, properties from the parent interface, Event, are available.

AnimationPlaybackEvent.currentTime Read only

The current time of the animation that generated the event.

AnimationPlaybackEvent.timelineTime Read only

The time value of the timeline of the animation that generated the event.

Examples

If this animation is canceled, remove its element.

js
animation.oncancel = (event) => {
  animation.effect.target.remove();
};

Specifications

Specification
Web Animations
# dom-animation-oncancel
Web Animations
# cancel-event

Browser compatibility

BCD tables only load in the browser

See also