Animation.onfinish

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The Animation.onfinish property of the Web Animations API is the event handler for the finish event.

The finish event can be triggered manually with Animation.finish().

Note: The paused playstate "wins" over the finished playstate (more info).

Syntax

// getting onfinish
var uponFinishing = animation.onfinish;

// setting onfinish
animation.onfinish = finishAction;

Value

A Function or null.

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 Animations
The definition of 'Animation.onfinish' in that specification.
Working Draft Editor's draft.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 39.0 48 (48) No support No support No support
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support (Yes) 48.0 (48) No support No support No support

 

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/animation/onfinish