ContextQMD
Back to Content

Animation

files/en-us/web/api/animation/index.md

latest5.8 KB
Original Source

{{ 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.overallProgress")}} {{ReadOnlyInline}}
    • : Returns a number between 0 and 1 indicating the animation's overall progress towards its finished state.
  • {{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}}
    • : Indicates whether the animation is active, has been automatically removed after being replaced by another animation, or has been explicitly persisted by a call to {{domxref("Animation.persist()")}}.
  • {{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 current styling state of an animation to the element being animated, even after that animation has been removed. It will cause the current 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()")}}
    • : Explicitly persists an animation, preventing it from being automatically removed when another animation replaces it.
  • {{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")}}

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 (or equivalent user agent client hint {{HTTPHeader("Sec-CH-Prefers-Reduced-Motion")}}) to create a complimentary experience for users who have expressed a preference for no animated experiences.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also