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.Animation() constructor.

Constructor

KeyframeEffect.KeyframeEffect()

Returns a new KeframeEffect object instance.

Properties

KeyframeEffect.target

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.

KeyframeEffect.spacing

Gets and sets the temporal spacing of the keyframe effect's iterations.

Methods

KeyframeEffect.clone()

Returns a new KeyframeEffect object whose members have the same values as this object.

KeyframeEffect.getFrames()

Returns the computed keyframes that make up this effect along with their computed keyframe offsets.

KeyframeEffect.setFrames()

Replaces the set of keyframes that make up this 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

Browser compatibility

See also

• Web Animations API
• Animation