Optionalprops: TModuleProps<Retrieves the module's callbacks instance.
Duration in milliseconds.
Non-finite or negative values are treated as 0 (instant completion).
Eased progress derived from progress and the easing prop.
Indicates whether the instance has been destroyed.
After destruction, destroy is a no-op.
Whether playback is paused.
Whether a requestAnimationFrame loop is active.
Whether playback direction is reversed.
The name of the module, derived from the class name
Optional prefix for classnames used by the module
Linear progress (0 → 1).
Assigning a value clamps, recalculates eased, and fires callbacks.
Current properties. Do not mutate these directly, use updateProps instead.
Protected_addAdds prefixed classes to an element and removes them on destroy.
Skips classes that are already present on the element.
Target DOM element.
Unprefixed class name segments.
Protected_cnBuilds one or more prefixed class names.
Unprefixed class name segments.
Space-separated prefixed class string.
Protected_destroyInternal method to handle the destruction of the module. It removes all callbacks, destroys properties, and cleans up event listeners and class names.
Protected_emitEmits a callback event with a fixed payload.
Set default mutable props
Timeline duration in milliseconds.
Easing applied to linear ITimelineProgressArg.progress.
Accepts a named easing type, bezier control points, or false for linear.
Get default static props
Protected_handleMethod that is called when the module's properties mutate. In most cases, used to handle callbacks.
Adds a custom callback to the module.
The event type to listen for (e.g., 'props', 'destroy').
The function to execute when the event is triggered.
Additional settings for the callback.
Registers a function to run when the instance is destroyed.
If the instance is already destroyed, action runs immediately.
Cleanup function (for example remove listeners or DOM classes).
Pauses playback without resetting progress.
Emits pause only when a rAF loop is active.
Plays forward toward progress = 1.
No-op when destroyed or when progress is already 1.
Pauses and sets progress to 0.
Plays backward toward progress = 0.
No-op when destroyed or when progress is already 0.
Timeline for time-based progress with easing.
0 → 1range with configurabledurationandeasingupdateon every progress change plus lifecycle callbacks (start,end,play,pause,reverse,reset,resume)Documentation