Animation.ready

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.ready property of the Web Animations API returns the current ready Promise for this object. The object is replaced with a new Promise object every time the animation enters the pending play state as well as when the animation is canceled.

Note: Since the same Promise object is used for both pending play and pending pause requests, authors are advised to check the state of the animation when the Promise object is resolved.

Syntax

animation.ready.then(function() {
  // do something when ready
});

Value

A Promise object.

Examples

In the following example, the state of the animation will be running when the current ready Promise is resolved because the animation does not leave the pending play state in between the calls to pause and play and hence the current ready Promise does not change.

animation.pause();
animation.ready.then(function() {
  // Displays 'running'
  alert(animation.playState);
});
animation.play();

Specifications

Specification Status Comment
Web Animations
The definition of 'Animation.ready' in that specification.
Working Draft Editor's draft.

Browser compatibility

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

 

See also

Document Tags and Contributors

 Contributors to this page: birtles, chrisdavidmills, rachelnabors
 Last updated by: birtles,