Animation.ready

Experimental

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

The read-only Animation.ready property of the Web Animations API returns a Promise which resolves when the animation is ready to play. A new promise is created every time the animation enters the "pending" play state as well as when the animation is canceled, since in both of those scenarios, the animation is ready to be started again.

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

Syntax

var readyPromise = Animation.ready;

Value

A Promise which resolves when the animation is ready to be played. You'll typically use a construct similar to this when using the ready promise:

animation.ready.then(function() {
  // Do whatever needs to be done when
  // the animation is ready to run
});

Example

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
Web Animations Level 2 (Web Animations 2)
# dom-animation-ready

Browser compatibility

BCD tables only load in the browser

See also