KeyframeEffect

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

The KeyframeEffect interface of the Web Animations API lets us create sets of animatable properties and values, called keyframes. These can then be played using the Animation() constructor.

Constructor

KeyframeEffect()
Returns a new KeyframeEffect object instance, and also allows you to clone an existing keyframe effect object instance.

Properties

KeyframeEffect.target
Gets and sets the element, or originating element of the pseudo-element, being animated by this object. This may be null for animations that do not target a specific element or pseudo-element.
KeyframeEffect.pseudoElement
Gets and sets the selector of the pseudo-element being animated by this object. This may be null for animations that do not target a pseudo-element.
KeyframeEffect.iterationComposite
Gets and sets the iteration composite operation for resolving the property value changes of this keyframe effect.
KeyframeEffect.composite
Gets and sets the composite operation property for resolving the property value changes between this and other keyframe effects.

Methods

This interface inherits some of its methods from its parent, AnimationEffect.

AnimationEffect.getComputedTiming()
Returns the calculated, current timing values for this keyframe effect.
KeyframeEffect.getKeyframes()
Returns the computed keyframes that make up this effect along with their computed keyframe offsets.
AnimationEffect.getTiming()
The EffectTiming object associated with the animation containing all the animation's timing values.
KeyframeEffect.setKeyframes()
Replaces the set of keyframes that make up this effect.
AnimationEffect.updateTiming()
Updates the specified timing properties.

Examples

In the Follow the White Rabbit example, the KeyframeEffect constructor is used to create a set of keyframes that dictate how the White Rabbit should animate down the hole:

 var rabbitDownKeyframes = new KeyframeEffect(
    whiteRabbit, // element to animate
    [
      { transform: 'translateY(0%)' }, // keyframe 
      { transform: 'translateY(100%)' } // keyframe
    ], 
    { duration: 3000, fill: 'forwards' } // keyframe options
  );

Specifications

Specification Status Comment
Web Animations
The definition of 'KeyframeEffect' in that specification.
Working Draft Initial definition

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
KeyframeEffect
Experimental
Chrome Full support YesEdge Full support ≤79Firefox Full support 63IE No support NoOpera Full support YesSafari No support NoWebView Android Full support YesChrome Android Full support YesFirefox Android Full support 63Opera Android Full support YesSafari iOS No support NoSamsung Internet Android Full support Yes
KeyframeEffect() constructor
Experimental
Chrome Full support YesEdge Full support ≤79Firefox Full support 63IE No support NoOpera No support NoSafari No support NoWebView Android Full support YesChrome Android Full support YesFirefox Android Full support 63Opera Android No support NoSafari iOS No support NoSamsung Internet Android Full support Yes
compositeChrome ? Edge ? Firefox Full support 63
Disabled
Full support 63
Disabled
Disabled From version 63: this feature is behind the dom.animations-api.compositing.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
IE No support NoOpera No support NoSafari No support NoWebView Android ? Chrome Android ? Firefox Android Full support 63
Disabled
Full support 63
Disabled
Disabled From version 63: this feature is behind the dom.animations-api.compositing.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
getKeyframesChrome ? Edge ? Firefox Full support 63IE No support NoOpera No support NoSafari No support NoWebView Android ? Chrome Android ? Firefox Android Full support 63Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
iterationCompositeChrome ? Edge ? Firefox Full support 63
Disabled
Full support 63
Disabled
Disabled From version 63: this feature is behind the dom.animations-api.compositing.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
IE No support NoOpera No support NoSafari No support NoWebView Android ? Chrome Android ? Firefox Android Full support 63
Disabled
Full support 63
Disabled
Disabled From version 63: this feature is behind the dom.animations-api.compositing.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
pseudoElement
Experimental
Chrome Full support 81
Disabled
Full support 81
Disabled
Disabled From version 81: this feature is behind the Experimental Web Platform Features preference. To change preferences in Chrome, visit chrome://flags.
Edge Full support 81
Disabled
Full support 81
Disabled
Disabled From version 81: this feature is behind the Experimental Web Platform Features preference.
Firefox Full support 75IE No support NoOpera Full support 68
Disabled
Full support 68
Disabled
Disabled From version 68: this feature is behind the Experimental Web Platform Features preference.
Safari No support NoWebView Android No support NoChrome Android Full support 81
Disabled
Full support 81
Disabled
Disabled From version 81: this feature is behind the Experimental Web Platform Features preference. To change preferences in Chrome, visit chrome://flags.
Firefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
setKeyframes
Experimental
Chrome No support NoEdge No support NoFirefox Full support 63IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoFirefox Android Full support 63Opera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
targetChrome ? Edge ? Firefox Full support 63IE No support NoOpera No support NoSafari No support NoWebView Android ? Chrome Android ? Firefox Android Full support 63Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?

Legend

Full support
Full support
No support
No support
Compatibility unknown
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.
User must explicitly enable this feature.

See also