This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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.

Properties

This interface inherits some of its methods and properties from its parent, KeyframeEffectReadOnly, and its grandparent AnimationEffectReadOnly.

AnimationEffectReadOnly.timing
The AnimationEffectTimingReadOnly object associated with the animation containing all the animation's timing values.
KeyframeEffectReadOnly.target
Gets and sets the element or pseudo-element being animated by this object. This may be null for animations that do not target a specific element.

Future properties

The following options are currently not shipped anywhere, but will be added in the near future.

KeyframeEffectReadOnly.iterationComposite
Gets and sets the iteration composite operation for resolving the property value changes of this keyframe effect.
KeyframeEffectReadOnly.composite
Gets and sets the composite operation property for resolving the property value changes between this and other keyframe effects.
KeyframeEffectReadOnly.spacing
Gets and sets the temporal spacing of the keyframe effect's iterations.

Methods

KeyframeEffectReadOnly.getKeyframes()
Returns the computed keyframes that make up this effect along with their computed keyframe offsets.
KeyframeEffect.setKeyframes()
Replaces the set of keyframes that make up this effect.
AnimationEffectReadOnly.getComputedTiming()
Returns the calculated, current timing values for this keyframe effect.

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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support 48 (48)[1] No support No support No support
Feature Android Android Webview Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
Basic support No support No support No support 48.0 (48)[1] No support No support No support No support

[1] The Web Animations API is only enabled by default in Firefox Developer Edition and Nightly builds. You can enable it in beta and release builds by setting the preference dom.animations-api.core.enabled to true, and can disable it in any Firefox version by setting this preference to false.

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, Sebastianz, birtles, rachelnabors, suzyh, chrisdavidmills, rolfedh
 Last updated by: Sheppy,