Global

Type Definitions

AnimateElement

Source:
Type:
  • HTMLElement | SVGElement

AnimatorOptions

Source:
Properties:
Name Type Description
id number | string The id represents the unique key of the animator.
easing string | EasingType The easing(timing-function) specifies the speed curve of an animation.
iterationCount IterationCountType The iterationCount property specifies the number of times an animation should be played.
delay number The delay property specifies a delay for the start of an animation.
fillMode FillModeType The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
direction DirectionType The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
playSpeed number The playspeed define the speed at which the play is performed.
duration number The duration property defines how long an animation should take to complete one cycle.
Type:
  • TSInterface

AnimatorState

Source:
Properties:
Name Type Description
duration? number The duration property defines how long an animation should take to complete one cycle.
fillMode? "none" | "forwards" | "backwards" | "both" The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
iterationCount? "infinite" | number The iterationCount property specifies the number of times an animation should be played.
easing? array | function The easing(timing-function) specifies the speed curve of an animation.
delay? number The delay property specifies a delay for the start of an animation.
direction? "normal" | "reverse" | "alternate" | "alternate-reverse" The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
The Animator options. Properties used in css animation.
Type:
  • Object

AnimatorState

Source:
See:
Properties:
Name Type Description
id number | string The id represents the unique key of the animator.
easing string | EasingType The easing(timing-function) specifies the speed curve of an animation.
iterationCount IterationCountType The iterationCount property specifies the number of times an animation should be played.
delay number The delay property specifies a delay for the start of an animation.
fillMode FillModeType The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
direction DirectionType The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
playSpeed number The playspeed define the speed at which the play is performed.
duration number The duration property defines how long an animation should take to complete one cycle.
easingName string
iterationTime number
currentTime number
tickTime number
iteration number
prevTime number
playState PlayStateType
Type:
  • TSInterface

CallbackType<T = any>

Source:
Type:
  • (...args: any[]) => T

DirectionType

Source:
Type:
  • "normal" | "reverse" | "alternate" | "alternate-reverse"

EasingFunction

Source:
Properties:
Name Type Description
easingName? string
Type:
  • TSInterface

EasingType

Source:
Type:

ElementsType

Source:
Type:
  • HTMLElement | HTMLElement[] | NodeListOf<HTMLElement>

EventParameter

Source:
Properties:
Name Type Description
[name: string] CallbackType | CallbackType[]
Type:
  • TSInterface

EventType

Source:
Type:
  • ["paused", "ended", "timeupdate", "animate", "play", "iteration"]

FillModeType

Source:
Type:
  • "forwards" | "backwards" | "both"

IterationCountType

Source:
Type:
  • number | "infinite"

KeyValueChildren

Source:
Properties:
Name Type Description
key string
value any
children KeyValueChildren[]
Type:
  • TSInterface

NameType

Source:
Type:
  • string | number

OptionType

Source:
Type:
  • ["duration", "fillMode", "direction", "iterationCount", "delay", "easing", "playSpeed"]

PlayCondition

Source:
Properties:
Name Type Description
className? string
selector? string | ((item: SceneItem, selector: string) => string)
Type:
  • TSInterface

PlayStateType

Source:
Type:
  • "paused" | "running"

PropertyObjectState

Source:
Properties:
Name Type Description
prefix string
suffix string
model string
type string
separator string
Type:
  • TSInterface

Role

Source:
Type:

RoleObject

Source:
Properties:
Name Type Description
[role: string] Role
Type:
  • TSInterface

SceneItemOptions

Source:
See:
Properties:
Name Type Description
id number | string The id represents the unique key of the animator.
easing string | EasingType The easing(timing-function) specifies the speed curve of an animation.
iterationCount IterationCountType The iterationCount property specifies the number of times an animation should be played.
delay number The delay property specifies a delay for the start of an animation.
fillMode FillModeType The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
direction DirectionType The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
playSpeed number The playspeed define the speed at which the play is performed.
duration number The duration property defines how long an animation should take to complete one cycle.
selector string | boolean | ((id: number | string) => string)
elements IArrayFormat<AnimateElement> | AnimateElement
element IArrayFormat<AnimateElement> | AnimateElement
target any
Type:
  • TSInterface

SceneItemState

Source:
See:
Properties:
Name Type Description
duration? number The duration property defines how long an animation should take to complete one cycle.
fillMode? "none" | "forwards" | "backwards" | "both" The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
iterationCount? "infinite" | number The iterationCount property specifies the number of times an animation should be played.
easing? array | function The easing(timing-function) specifies the speed curve of an animation.
delay? number The delay property specifies a delay for the start of an animation.
direction? "normal" | "reverse" | "alternate" | "alternate-reverse" The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
playCSS boolean
cssText string
selector string
exportEvent? boolean
Type:
  • TSInterface

SceneOptions

Source:
See:
Properties:
Name Type Description
id number | string The id represents the unique key of the animator.
easing string | EasingType The easing(timing-function) specifies the speed curve of an animation.
iterationCount IterationCountType The iterationCount property specifies the number of times an animation should be played.
delay number The delay property specifies a delay for the start of an animation.
fillMode FillModeType The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
direction DirectionType The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
playSpeed number The playspeed define the speed at which the play is performed.
duration number The duration property defines how long an animation should take to complete one cycle.
selector string | boolean | ((id: number | string) => string)
Type:
  • TSInterface

SceneState

Source:
See:
Properties:
Name Type Description
duration? number The duration property defines how long an animation should take to complete one cycle.
fillMode? "none" | "forwards" | "backwards" | "both" The fillMode property specifies a style for the element when the animation is not playing (before it starts, after it ends, or both).
iterationCount? "infinite" | number The iterationCount property specifies the number of times an animation should be played.
easing? array | function The easing(timing-function) specifies the speed curve of an animation.
delay? number The delay property specifies a delay for the start of an animation.
direction? "normal" | "reverse" | "alternate" | "alternate-reverse" The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
selector string | boolean | ((id: number | string) => string)
playCSS boolean
exportEvent? boolean
Type:
  • TSInterface