AnimationEvent: AnimationEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.

The AnimationEvent() constructor returns a new AnimationEvent object, representing an event in relation with an animation.

Syntax

js
new AnimationEvent(type)
new AnimationEvent(type, options)

Parameters

type

A string with the name of the type of the AnimationEvent. It is case-sensitive and browsers set it to animationstart, animationend, or animationiteration.

options Optional

An object that, in addition of the properties defined in Event(), has the following properties:

animationName Optional

A string containing the value of the animation-name CSS property associated with the transition. It defaults to "".

elapsedTime Optional

A float giving the amount of time the animation has been running, in seconds, when this event fired, excluding any time the animation was paused. For an animationstart event, elapsedTime is 0.0 unless there was a negative value for animation-delay, in which case the event will be fired with elapsedTime containing (-1 * delay). It defaults to 0.0.

pseudoElement Optional

A string, starting with "::", containing the name of the pseudo-element the animation runs on. If the animation doesn't run on a pseudo-element but on the element itself, specify an empty string: "". It defaults to "".

Specifications

Specification
CSS Animations Level 1
# dom-animationevent-animationevent

Browser compatibility

BCD tables only load in the browser

See also