Class AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>

Launches an animation frame with a specified FPS, allowing control over playback and FPS calculations in real-time.

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- AnimationFrame

Index

Constructors

constructor

Accessors

callbacks computedFPS fpsMultiplier isDestroyed isInitialized isPlaying name prefix props

Methods

addCallback addEventListener addPlugin addResponsiveProps addViewportCallback changeProps destroy init pause play

Constructors

constructor

new AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NAnimationFrame.IStaticProps = NAnimationFrame.IStaticProps
- ChangeableProps extends NAnimationFrame.IChangeableProps = NAnimationFrame.IChangeableProps
- CallbacksTypes extends NAnimationFrame.ICallbacksTypes = NAnimationFrame.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>
Overrides Component.constructor
- Defined in src/components/AnimationFrame/index.ts:67

Accessors

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Retrieves the module's registered callbacks.

Returns Callbacks<CallbacksTypes>
Inherited from ComponentClass.callbacks
- Defined in src/base/Module/index.ts:79

computedFPS

get computedFPS(): number
Returns the current computed FPS, which may differ from the set FPS

Returns number
- Defined in src/components/AnimationFrame/index.ts:58

fpsMultiplier

get fpsMultiplier(): number
Coefficient that scales based on a target of 60 FPS compared to the computed FPS

Returns number
- Defined in src/components/AnimationFrame/index.ts:63

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

Returns boolean
Inherited from ComponentClass.isDestroyed
- Defined in src/base/Module/index.ts:118

isInitialized

get isInitialized(): boolean
Checks if the module has been initialized.

Returns boolean
Inherited from ComponentClass.isInitialized
- Defined in src/base/Module/index.ts:108

isPlaying

get isPlaying(): boolean
Returns the current playback state of the animation frame

Returns boolean
- Defined in src/components/AnimationFrame/index.ts:35

name

get name(): string
The name of the module, derived from the class name

Returns string
Inherited from ComponentClass.name
- Defined in src/base/Module/index.ts:93

prefix

get prefix(): string
Optional prefix for class names used by the module

Returns string
Inherited from ComponentClass.prefix
- Defined in src/base/Module/index.ts:98

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
The current properties of the module, which include both static and changeable properties. These can be retrieved dynamically during the module's lifecycle.

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
Inherited from ComponentClass.props
- Defined in src/base/Module/index.ts:64

Methods

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  
  The event type to listen for (e.g., 'propsChange', 'destroy').
- action: TAction<CallbacksTypes[T]>
  
  The function to execute when the event is triggered.
- settings: ISettings = {}
  
  Additional settings for the callback.
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

addEventListener

addEventListener<Target, Listener>(element, target, callback, options?): (() => void)
Adds a DOM event listener that will be automatically removed when the module is destroyed.
Type Parameters
- Target extends keyof HTMLElementEventMap
- Listener extends ((event) => void)
Parameters
- element: Document | Element | Window
  
  The target element for the event listener.
- target: Target
  
  The event type to listen for (e.g., 'click', 'resize').
- callback: Listener
  
  The callback function to execute when the event is triggered.
- Optional options: boolean | AddEventListenerOptions
  
  Additional options for the event listener.
Returns (() => void)
- - (): void
  - Returns void
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:261

addPlugin

addPlugin<T>(plugin): void
Adds a plugin to the component. The plugin is initialized upon being added, and the plugin's component property is set to the current component instance.
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
  
  An instance of the Plugin class to be added.
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:30

addResponsiveProps

addResponsiveProps(rules): void
Adds responsive property rules to the module. This must be done before initialization.
Parameters
- rules: IResponsive<ChangeableProps>
  
  The responsive property rules to be added.
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:159

addViewportCallback

addViewportCallback(target, action, data?): void
Adds a viewport callback that will be automatically removed when the module is destroyed.
Parameters
- target: keyof IViewportCallbackTypes
  
  The viewport target (e.g., width or height).
- action: (() => void)
  
  The callback function to execute when the viewport target changes.
  - - (): void
    - Returns void
- data: undefined | ISettings = {}
  
  Additional data for the callback.
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:225

changeProps

changeProps(props): void
Updates the changeable properties of the module.
Parameters
- props: Partial<ChangeableProps>
  
  The properties to be updated.
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:174

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

Returns void
Inherited from Component.destroy
- Defined in src/base/Module/index.ts:310

init

init(): void
Initializes the module. Calls the internal _init method and marks the module as initialized.

Returns void
Inherited from Component.init
- Defined in src/base/Module/index.ts:194

pause

pause(): void
Pauses the animation loop

Returns void
- Defined in src/components/AnimationFrame/index.ts:133

play

play(): void
Begins the animation loop

Returns void
- Defined in src/components/AnimationFrame/index.ts:106

Class AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>

Link

Link

Type Parameters

StaticProps extends NAnimationFrame.IStaticProps = NAnimationFrame.IStaticProps

ChangeableProps extends NAnimationFrame.IChangeableProps = NAnimationFrame.IChangeableProps

CallbacksTypes extends NAnimationFrame.ICallbacksTypes = NAnimationFrame.ICallbacksTypes

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NAnimationFrame.IStaticProps = NAnimationFrame.IStaticProps

ChangeableProps extends NAnimationFrame.IChangeableProps = NAnimationFrame.IChangeableProps

CallbacksTypes extends NAnimationFrame.ICallbacksTypes = NAnimationFrame.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns AnimationFrame<StaticProps, ChangeableProps, CallbacksTypes>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

computedFPS

Returns number

fpsMultiplier

Returns number

isDestroyed

Returns boolean

isInitialized

Returns boolean

isPlaying

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addEventListener

Type Parameters

Target extends keyof HTMLElementEventMap

Listener extends ((event) => void)

Parameters

element: Document | Element | Window

target: Target

callback: Listener

Optional options: boolean | AddEventListenerOptions

Returns (() => void)

Returns void

addPlugin

Type Parameters

T extends Plugin<any, any, any, any>

Parameters

plugin: T

Returns void

addResponsiveProps

Parameters

rules: IResponsive<ChangeableProps>

Returns void

addViewportCallback

Parameters

target: keyof IViewportCallbackTypes

action: (() => void)

Returns void

data: undefined | ISettings = {}

Returns void

changeProps

Parameters

`Optional` initialProps: StaticProps & ChangeableProps

`Optional` options: boolean | AddEventListenerOptions