Skip to content

KeyframeKit / KeyframeEffectParameters

Class: KeyframeEffectParameters

https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface

Constructors

Constructor

ts
new KeyframeEffectParameters(obj: {
  keyframes: KeyframeArgument;
  options?: number | KeyframeEffectOptions;
}): KeyframeEffectParameters;

Parameters

obj
keyframes

KeyframeArgument

MDN Reference

options?

number | KeyframeEffectOptions = {}

MDN Reference

Returns

KeyframeEffectParameters

Properties

keyframes

ts
keyframes: KeyframeArgument;

options

ts
options: KeyframeEffectOptions;

Methods

toAnimation()

ts
toAnimation(obj: {
  options?: number | KeyframeEffectOptions;
  target: Element | null;
  timeline?: AnimationTimeline;
}): Animation;

Parameters

obj
options?

number | KeyframeEffectOptions = {}

Additional keyframe effect options. Can override existing keys. MDN Reference

target

Element | null

An element to attach the animation to.

timeline?

AnimationTimeline = document.timeline

Returns

Animation

See

Specifications: