Element: getAnimations() method
The getAnimations()
method of the Element
interface
(specified on the Animatable
mixin) returns an array of all
Animation
objects affecting this element or which are scheduled to do so
in future. It can optionally return Animation
objects for descendant
elements too.
Note: This array includes CSS Animations, CSS Transitions, and Web Animations.
Syntax
js
getAnimations()
getAnimations(options)
Parameters
options
Optional-
An options object containing the following property:
subtree
-
A boolean value which, if
true
, causes animations that target descendants of Element to be returned as well. This includes animations that target any CSS pseudo-elements attached to Element or one of its descendants. Defaults tofalse
.
Return value
Examples
The following code snippet will wait for all animations on elem
and its
descendants to finish before removing the element from the document.
js
Promise.all(
elem.getAnimations({ subtree: true }).map((animation) => animation.finished)
).then(() => elem.remove());
Specifications
Specification |
---|
Web Animations # dom-animatable-getanimations |
Browser compatibility
BCD tables only load in the browser
See also
- Web Animations API
- CSS Animations
- CSS Transitions
Document.getAnimations()
- Fetch all animations in the documentAnimation