KeyframeEffect

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{ APIRef("Web Animations") }}

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 {{domxref("Animation.Animation", "Animation()")}} constructor.

{{InheritanceDiagram}}

Constructor

  • {{domxref("KeyframeEffect.KeyframeEffect", "KeyframeEffect()")}}
  • : Returns a new KeyframeEffect object instance, and also allows you to clone an existing keyframe effect object instance.

Instance properties

  • {{domxref("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.
  • {{domxref("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.
  • {{domxref("KeyframeEffect.iterationComposite")}}
  • : Gets and sets the iteration composite operation for resolving the property value changes of this keyframe effect.
  • {{domxref("KeyframeEffect.composite")}}
  • : Gets and sets the composite operation property for resolving the property value changes between this and other keyframe effects.

Instance methods

_This interface inherits some of its methods from its parent, {{domxref("AnimationEffect")}}._

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

Examples

In the following example, the KeyframeEffect constructor is used to create a set of keyframes that dictate how the rofl emoji should roll on the floor:

js
const emoji = document.querySelector("div"); // element to animate

const rollingKeyframes = new KeyframeEffect(
  emoji,
  [
    { transform: "translateX(0) rotate(0)" }, // keyframe
    { transform: "translateX(200px) rotate(1.3turn)" }, // keyframe
  ],
  {
    // keyframe options
    duration: 2000,
    direction: "alternate",
    easing: "ease-in-out",
    iterations: "Infinity",
  },
);

const rollingAnimation = new Animation(rollingKeyframes, document.timeline);

// play rofl animation
rollingAnimation.play();
html
<div>🤣</div>
css hidden

{{ EmbedLiveSample("Examples", "100%", "120") }}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • Web Animations API
  • {{domxref("Animation")}}