This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The oncancel
property of the Web Animations API's Animation
interface is the event handler for the cancel
event.
The cancel
event can be triggered manually with Animation.cancel()
when the animation enters the "idle"
play state from another state, such as when the animation is removed from an element before it finishes playing
Creating a new animation that is initially idle does not trigger a cancel
event on the new animation.
Syntax
var cancelHandler = Animation.oncancel; Animation.oncancel = cancelHandler;
Value
A function to be executed when the animation is cancelled, or null
if there is no cancel
event handler.
Examples
If this animation is canceled, remove its element.
animation.oncancel = function() { animation.effect.target.remove(); };
Specifications
Specification | Status | Comment |
---|---|---|
Web Animations The definition of 'Animation.oncancel' 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
oncancel | Chrome Full support 50 | Edge Full support ≤79 | Firefox
Full support
48
| IE No support No | Opera Full support 37 | Safari No support No | WebView Android Full support 50 | Chrome Android Full support 50 | Firefox Android
Full support
48
| Opera Android Full support 37 | Safari iOS No support No | Samsung Internet Android Full support 5.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
- The
cancel
event