Element.getAnimations()

Our volunteers haven't translated this article into Српски yet. Join us and help get the job done!
You can also read the article in English (US).

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

const animations = Element.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 descendents. Defaults to false.

Return value

An Array of Animation objects, each representing an animation currently targetting the Element on which this method is called, or one of its descendant elements if { subtree: true } is specified.

Examples

The following code snippet will wait for all animations on elem and its descendants to finish before removing the element from the document.

Promise.all(
  elem.getAnimations({ subtree: true })
    .map(animation => animation.finished)
).then(() => elem.remove());

Specifications

Specification Status Comment
Web Animations
The definition of 'Animatable.getAnimations()' in that specification.
Working Draft Editor's draft.

Browser compatibility

No compatibility data found. Please contribute data for "api.Element.getAnimations" (depth: 1) to the MDN compatibility data repository.

See also

Document Tags and Contributors

Contributors to this page: birtles, chrisdavidmills
Last updated by: birtles,