Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
mohamedkhallouq
GitHub Repository: mohamedkhallouq/content
 Path: blob/main/files/en-us/web/api/animation/index.md
6532 views
---
title: Animation
slug: Web/API/Animation
page-type: web-api-interface
browser-compat: api.Animation
---

{{ APIRef("Web Animations") }}

The Animation interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source.

{{InheritanceDiagram}}

Constructor

  • {{domxref("Animation.Animation()", "Animation()")}}

    • : Creates a new Animation object instance.

Instance properties

  • {{domxref("Animation.currentTime")}}

    • : The current time value of the animation in milliseconds, whether running or paused. If the animation lacks a {{domxref("AnimationTimeline", "timeline")}}, is inactive or hasn't been played yet, its value is null.

  • {{domxref("Animation.effect")}}

    • : Gets and sets the {{domxref("AnimationEffect")}} associated with this animation. This will usually be a {{domxref("KeyframeEffect")}} object.

  • {{domxref("Animation.finished")}} {{ReadOnlyInline}}

    • : Returns the current finished Promise for this animation.

  • {{domxref("Animation.id")}}

    • : Gets and sets the String used to identify the animation.

  • {{domxref("Animation.pending")}} {{ReadOnlyInline}}

    • : Indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation.

  • {{domxref("Animation.playState")}} {{ReadOnlyInline}}

    • : Returns an enumerated value describing the playback state of an animation.

  • {{domxref("Animation.playbackRate")}}

    • : Gets or sets the playback rate of the animation.

  • {{domxref("Animation.ready")}} {{ReadOnlyInline}}

    • : Returns the current ready Promise for this animation.

  • {{domxref("animation.replaceState")}} {{ReadOnlyInline}}

    • : Returns the replace state of the animation. This will be active if the animation has been replaced, or persisted if {{domxref("Animation.persist()")}} has been invoked on it.

  • {{domxref("Animation.startTime")}}

    • : Gets or sets the scheduled time when an animation's playback should begin.

  • {{domxref("Animation.timeline")}}

    • : Gets or sets the {{domxref("AnimationTimeline", "timeline")}} associated with this animation.

Instance methods

  • {{domxref("Animation.cancel()")}}

    • : Clears all {{domxref("KeyframeEffect", "keyframeEffects")}} caused by this animation and aborts its playback.

  • {{domxref("animation.commitStyles()")}}

    • : Commits the end styling state of an animation to the element being animated, even after that animation has been removed. It will cause the end styling state to be written to the element being animated, in the form of properties inside a style attribute.

  • {{domxref("Animation.finish()")}}

    • : Seeks either end of an animation, depending on whether the animation is playing or reversing.

  • {{domxref("Animation.pause()")}}

    • : Suspends playing of an animation.

  • {{domxref("animation.persist()")}}

  • {{domxref("Animation.play()")}}

    • : Starts or resumes playing of an animation, or begins the animation again if it previously finished.

  • {{domxref("Animation.reverse()")}}

    • : Reverses playback direction, stopping at the start of the animation. If the animation is finished or unplayed, it will play from end to beginning.

  • {{domxref("Animation.updatePlaybackRate()")}}

    • : Sets the speed of an animation after first synchronizing its playback position.

Events

  • {{domxref("Animation.cancel_event", "cancel")}}

    • : Fires when the {{domxref("Animation.cancel()")}} method is called or when the animation enters the "idle" play state from another state.

  • {{domxref("Animation.finish_event", "finish")}}

    • : Fires when the animation finishes playing.

  • {{domxref("animation.remove_event", "remove")}}

    • : Fires when the animation is removed (i.e., put into an active replace state).

Automatically removing filling animations

It is possible to trigger a large number of animations on the same element. If they are indefinite (i.e., forwards-filling), this can result in a huge animations list, which could create a memory leak. For this reason, modern browsers have implemented the part of the Web Animations spec that automatically removes overriding forward filling animations, unless the developer explicitly specifies to keep them.

You can see this in action in our simple replace indefinite animations demo. The related JavaScript features are:

  • {{domxref("animation.commitStyles()")}} for committing the end styling state of an animation to the element being animated, even after that animation has been removed.

  • The {{domxref("animation/remove_event", "remove")}} event on the {{domxref("Animation")}} interface fires when the animation is removed (i.e., put into an active replace state).

  • {{domxref("animation.persist()")}} for when you explicitly want an animation to be retained.

  • {{domxref("animation.replaceState")}} to return the replace state of the animation. This will be active if the animation has been removed, or persisted if {{domxref("Animation.persist", "persist()")}} has been invoked.

Accessibility concerns

Blinking and flashing animation can be problematic for people with cognitive concerns such as Attention Deficit Hyperactivity Disorder (ADHD). Additionally, certain kinds of motion can be a trigger for Vestibular disorders, epilepsy, and migraine, and Scotopic sensitivity.

Consider providing a mechanism for pausing or disabling animation, as well as using the Reduced Motion Media Query to create a complimentary experience for users who have expressed a preference for no animated experiences.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also