KeyframeEffect

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 pseudo-element being animated by this object. This may be null for animations that do not target a specific 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

Browser compatibilityUpdate compatibility data on GitHub

See also

• Web Animations API
• Animation