The pause()
method of the Web Animations API's Animation
interface suspends playback of the animation.
The pause()
method of the Web Animations API's Animation
interface suspends playback of the animation.
js
animation.pause();
None.
None.
InvalidStateError
DOMException
Thrown if the animation's currentTime
is unresolved
(perhaps it hasn't started playing yet), and the end time of the animation is positive infinity.
Animation.pause()
is used many times in the Alice in Web Animations API Land Growing/Shrinking Alice Game, largely because animations created with the Element.animate()
method immediately start playing and must be paused manually if you want to avoid that:
js
// animation of the cupcake slowly getting eaten up const nommingCake = document .getElementById("eat-me_sprite") .animate( [{ transform: "translateY(0)" }, { transform: "translateY(-80%)" }], { fill: "forwards", easing: "steps(4, end)", duration: aliceChange.effect.timing.duration / 2, }, ); // doesn't actually need to be eaten until a click event, so pause it initially: nommingCake.pause();
Additionally, when resetting:
js
// An all-purpose function to pause the animations on Alice, the cupcake, and the bottle that reads "drink me." const stopPlayingAlice = () => { aliceChange.pause(); nommingCake.pause(); drinking.pause(); }; // When the user releases the cupcake or the bottle, pause the animations. cake.addEventListener("mouseup", stopPlayingAlice, false); bottle.addEventListener("mouseup", stopPlayingAlice, false);
Specification |
---|
Web Animations # dom-animation-pause |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
pause |
75 | 79 | 48 | No | 62 | 13.1 | 75 | 75 | 48 | 54 | 13.4 | 11.0 |
Animation
for other methods and properties you can use to control web page animation.Animation.pause()
to pause an animation.Animation.reverse()
to play an animation backwards.Animation.finish()
to finish an animation.Animation.cancel()
to cancel an animation.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Animation/pause