This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Web Animations API's cancel()
method of the Animation
interface clears all KeyframeEffect
s caused by this animation and aborts its playback.
When an animation is cancelled, its startTime
and currentTime
are set to null
.
Syntax
Animation.cancel();
Parameters
None.
Return value
None.
Exceptions
This method doesn't directly throw exceptions; however, if the animation's playState
is anything but "idle"
when cancelled, the current finished promise is rejected with a DOMException
named AbortError
.
Specifications
Specification | Status | Comment |
---|---|---|
Web Animations The definition of 'Animation.cancel()' in that specification. |
Working Draft | Editor's 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
cancel | 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
KeyframeEffect
Animation
Animation.playState
Animation.finished
returns the promise this action will reject if the animation'splayState
is not"idle"
.