Web/API/Animation/onfinish

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The Animation interface's onfinish property (from the Web Animations API) is the event handler for the finish event. This event is sent when the animation finishes playing.

The finish event occurs when the animation completes naturally, as well as when the Animation.finish() method is called to immediately cause the animation to finish up.

The "paused" play state supersedes the "finished" play state; if the animation is both paused and finished, the "paused" state is the one that will be reported. You can force the animation into the "finished" state by setting its startTime to document.timeline.currentTime - (Animation.currentTime * Animation.playbackRate).

Syntax

var finishHandler = Animation.onfinish;

Animation.onfinish = finishHandler;

Value

A function to be called to handle the finish event, or null if no finish event handler is set.

Examples

Animation.onfinish is used several times in the Alice in Web Animations API Land Growing/Shrinking Alice Game. Here is one instance where we add pointer events back to an element after its opacity animation has faded it in:

// Add an animation to the game's ending credits
var endingUI = document.getElementById("ending-ui");
var bringUI = endingUI.animate(keysFade, timingFade);

// Pause said animation's credits
bringUI.pause();

// This function removes pointer events on the credits.
hide(endingUI);

// When the credits are later faded in, 
// we re-add the pointer events when they're done
bringUI.onfinish = function() {
  endingUI.style.pointerEvents = 'auto';
};

Specifications

Specification	Status	Comment
Web AnimationsThe definition of 'Animation.onfinish' in that specification.	Working Draft	Editor's draft.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`onfinish` Experimental'	Chrome Full support 39	Edge Full support 79	Firefox Full support 48 Full support 48 No support 46 — 48 Disabled' Disabled' From version 46 until version 48 (exclusive): this feature is behind the `dom.animations-api.core.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 26	Safari No support No	WebView Android Full support 39	Chrome Android Full support 39	Firefox Android Full support 48 Full support 48 No support 46 — 48 Disabled' Disabled' From version 46 until version 48 (exclusive): this feature is behind the `dom.animations-api.core.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 26	Safari iOS No support No	Samsung Internet Android Full support 4.0

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.': User must explicitly enable this feature.