Global

Type Definitions

AnimateElement

Source:
Type:
  • HTMLElement | SVGElement

AnimatorEvents

Source:
Properties:
play:
paused:
ended:
timeupdate: OnTimeUpdate
iteration: OnIteration
Type:
  • TSInterface

AnimatorOptions

Source:
Properties:
id
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:
duration optional
duration?: number
The duration property defines how long an animation should take to complete one cycle.
fillMode optional
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 optional
iterationCount?: "infinite" | number
The iterationCount property specifies the number of times an animation should be played.
easing optional
easing?: array | function
The easing(timing-function) specifies the speed curve of an animation.
delay optional
delay?: number
The delay property specifies a delay for the start of an animation.
direction optional
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:
id
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
Type:
  • TSInterface

CallbackType<T = any>

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

DirectionType

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

EasingFunction

Source:
Properties:
easingName optional
easingName?: string
Type:
  • TSInterface

EasingType

Source:
Type:

ElementsType

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

EventParameter

Source:
Properties:
Type:
  • TSInterface

EventType

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

FillModeType

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

FrameEvents

Source:
Properties:
update:
Type:
  • TSInterface

IterationCountType

Source:
Type:
  • number | "infinite"

KeyValueChildren

Source:
Properties:
key
key: string
value: any
Type:
  • TSInterface

NameType

Source:
Type:
  • string | number

OnAnimate

Source:
Properties:
currentTime: number
time: number
Type:
  • TSInterface

OnIteration

Source:
Properties:
currentTime: number
iterationCount: number
Type:
  • TSInterface

OnSceneAnimate

Source:
Properties:
currentTime: number
time: number
frames: Record<string, any>
Type:
  • TSInterface

OnSceneItemAnimate

Source:
Properties:
currentTime: number
time: number
frame: Frame
Type:
  • TSInterface

OnTimeUpdate

Source:
Properties:
currentTime: number
time: number
iterationCount: number
Type:
  • TSInterface

OptionType

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

PlayCondition

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

PlayStateType

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

PropertyObjectState

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

Role

Source:
Type:

RoleObject

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

SceneAnimatorEvents

Source:
Properties:
play:
paused:
ended:
timeupdate: OnTimeUpdate
iteration: OnIteration
animate: OnAnimate
Type:
  • TSInterface

SceneEvents

Source:
Properties:
play:
paused:
ended:
timeupdate: OnTimeUpdate
iteration: OnIteration
animate: OnAnimate
Type:
  • TSInterface

SceneItemEvents

Source:
Properties:
play:
paused:
ended:
timeupdate: OnTimeUpdate
iteration: OnIteration
animate: OnAnimate
Type:
  • TSInterface

SceneItemOptions

Source:
See:
Properties:
id
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 | Ref<AnimateElement>
element: IArrayFormat<AnimateElement> | AnimateElement | Ref<AnimateElement>
noRegisterElement: boolean
target: any
Type:
  • TSInterface

SceneItemSelectorType

Source:
Type:

SceneItemState

Source:
See:
Properties:
duration optional
duration?: number
The duration property defines how long an animation should take to complete one cycle.
fillMode optional
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 optional
iterationCount?: "infinite" | number
The iterationCount property specifies the number of times an animation should be played.
easing optional
easing?: array | function
The easing(timing-function) specifies the speed curve of an animation.
delay optional
delay?: number
The delay property specifies a delay for the start of an animation.
direction optional
direction?: "normal" | "reverse" | "alternate" | "alternate-reverse"
The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
noRegisterElement: boolean
playCSS: boolean
cssText: string
selector: string
exportEvent optional
exportEvent?: boolean
Type:
  • TSInterface

SceneOptions

Source:
See:
Properties:
id
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.
noRegisterElement: boolean
Type:
  • TSInterface

SceneState

Source:
See:
Properties:
duration optional
duration?: number
The duration property defines how long an animation should take to complete one cycle.
fillMode optional
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 optional
iterationCount?: "infinite" | number
The iterationCount property specifies the number of times an animation should be played.
easing optional
easing?: array | function
The easing(timing-function) specifies the speed curve of an animation.
delay optional
delay?: number
The delay property specifies a delay for the start of an animation.
direction optional
direction?: "normal" | "reverse" | "alternate" | "alternate-reverse"
The direction property defines whether an animation should be played forwards, backwards or in alternate cycles.
noRegisterElement: boolean
selector: string | boolean | ((id: number | string) => string | AnimateElement)
playCSS: boolean
exportEvent optional
exportEvent?: boolean
Type:
  • TSInterface

SelectorAllType

Source:
Type:
  • ((index: number) => any) & {defaultCount: number}