This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The pause()
method of the Web Animations API's Animation
interface suspends playback of the animation.
Syntax
animation.pause();
Parameters
None.
Return value
None.
Exceptions
- InvalidStateError
- The animation's
currentTime
isunresolved
(for example, if it's never been played or isn't currently playing) and the end time of the animation is positive infinity.
Throws an InvalidStateError
if the animation's currentTime
is unresolved
(perhaps it hasn't started playing yet) and the end time of the animation is positive infinity.
Example
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:
// animation of the cupcake slowly getting eaten up var 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 :
// An all-purpose function to pause the animations on Alice, the cupcake, and the bottle that reads "drink me." var stopPlayingAlice = function() { 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);
Specifications
Specification | Status | Comment |
---|---|---|
Web Animations The definition of 'play()' in that specification. |
Working Draft |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
pause | Chrome Full support 39 | Edge Full support ≤79 | Firefox
Full support
48
| 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
| 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.
See also
- Web Animations API
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.