Draft This page is not complete.
This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.
The KeyframeEffectOptions
dictionary, part of the Web Animations API, is used by Element.animate()
, KeyframeEffectReadOnly()
and KeyframeEffect()
to describe timing properties for animation effects. These properties are all optional, although without setting a duration
the animation will not play.
Simply put, these properties describe how the user agent should go about making the transition from keyframe to keyframe, and how to behave when the animation begins and ends.
Properties
composite
' Optional- Determines how values are combined between this animation and other, separate animations that do not specify their own specific composite operation. Defaults to
replace
.
add
dictates an additive effect, where each successive iteration builds on the last. For instance withtransform
, atranslateX(-200px)
would not override an earlierrotate(20deg)
value but result intranslateX(-200px) rotate(20deg)
.accumulate
is similar but a little smarter:blur(2)
andblur(5)
becomeblur(7)
, notblur(2) blur(5)
.replace
overwrites the previous value with the new one.
iterationComposite
' Optional- Determines how values build from iteration to iteration in this animation. Can be set to
accumulate
orreplace
(see above). Defaults toreplace
. pseudoElement
' Optional- The selector of the pseudo-element to be targeted, if any. Defaults to
null
. - ;;
delay
Optional
- The number of milliseconds to delay the start of the animation. Defaults to 0.
direction
Optional- Whether the animation runs forwards (
normal
), backwards (reverse
), switches direction after each iteration (alternate
), or runs backwards and switches direction after each iteration (alternate-reverse
). Defaults to"normal"
. duration
Optional- The number of milliseconds each iteration of the animation takes to complete. Defaults to 0. Although this is technically optional, keep in mind that your animation will not run if this value is 0.
easing
Optional- The rate of the animation's change over time. Accepts the pre-defined values
"linear"
,"ease"
,"ease-in"
,"ease-out"
, and"ease-in-out"
, or a custom"cubic-bezier"
value like"cubic-bezier(0.42, 0, 0.58, 1)"
. Defaults to"linear"
. endDelay
Optional- The number of milliseconds to delay after the end of an animation. This is primarily of use when sequencing animations based on the end time of another animation. Defaults to 0.
fill
Optional- Dictates whether the animation's effects should be reflected by the element(s) prior to playing (
"backwards"
), retained after the animation has completed playing ("forwards"
), orboth
. Defaults to"none"
. iterationStart
Optional- Describes at what point in the iteration the animation should start. 0.5 would indicate starting halfway through the first iteration for example, and with this value set, an animation with 2 iterations would end halfway through a third iteration. Defaults to 0.0.
iterations
Optional- The number of times the animation should repeat. Defaults to
1
, and can also take a value ofInfinity
to make it repeat for as long as the element exists.
Specifications
Specification | Status | Comment |
---|---|---|
Web Animations Level 2The definition of 'KeyframeEffectOptions' in that specification. | Draft | Added the iterationComposite option.
|
Web AnimationsThe definition of 'KeyframeEffectOptions' 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.
No compatibility data found. Please contribute data for "api.KeyframeEffectOptions" (depth: 1) to the MDN compatibility data repository.
See also
EffectTiming
- Web Animations API
- Using the Web Animations API
Element.animate()
KeyframeEffect()
KeyframeEffectReadOnly()
KeyframeEffectOptions by Mozilla Contributors is licensed under CC-BY-SA 2.5.