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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
KeyframeEffect | Chrome Full support Yes | Edge Full support ≤79 | Firefox Full support 63 | IE No support No | Opera Full support Yes | Safari No support No | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 63 | Opera Android Full support Yes | Safari iOS No support No | Samsung Internet Android Full support Yes |
KeyframeEffect() constructor | Chrome Full support Yes | Edge Full support ≤79 | Firefox Full support 63 | IE No support No | Opera No support No | Safari No support No | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 63 | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support Yes |
composite | Chrome ? | Edge ? | Firefox
Full support
63
| IE No support No | Opera No support No | Safari No support No | WebView Android ? | Chrome Android ? | Firefox Android
Full support
63
| Opera Android No support No | Safari iOS No support No | Samsung Internet Android ? |
getKeyframes | Chrome ? | Edge ? | Firefox Full support 63 | IE No support No | Opera No support No | Safari No support No | WebView Android ? | Chrome Android ? | Firefox Android Full support 63 | Opera Android No support No | Safari iOS No support No | Samsung Internet Android ? |
iterationComposite | Chrome ? | Edge ? | Firefox
Full support
63
| IE No support No | Opera No support No | Safari No support No | WebView Android ? | Chrome Android ? | Firefox Android
Full support
63
| Opera Android No support No | Safari iOS No support No | Samsung Internet Android ? |
pseudoElement | Chrome
Full support
81
| Edge
Full support
81
| Firefox Full support 75 | IE No support No | Opera
Full support
68
| Safari No support No | WebView Android No support No | Chrome Android
Full support
81
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
setKeyframes | Chrome No support No | Edge No support No | Firefox Full support 63 | IE No support No | Opera No support No | Safari No support No | WebView Android No support No | Chrome Android No support No | Firefox Android Full support 63 | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
target | Chrome ? | Edge ? | Firefox Full support 63 | IE No support No | Opera No support No | Safari No support No | WebView Android ? | Chrome Android ? | Firefox Android Full support 63 | Opera Android No support No | Safari iOS No support No | Samsung 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.