Optionalprops: StaticProps & MutablePropsProtected_activeActive slide index
Protected_callbacksCallbacks instance
Protected_destroyableStores actions that need to be executed when the module is destroyed
Protected_domContainer size
Protected_isTracks whether the module has been destroyed
Protected_keyboardSnap keyboard
Protected_propsCurrent properties
Protected_rafAnimation frame for smooth animations
Protected_resizeResize handler
Protected_slidesAll slides
Protected_swipeSwipe events
Protected Optional_timelineTimeline for smooth transitions
Protected_trackSnap Track
Protected_wheelWheel events
Active slide index
Active slide
Get axis name depending on direction
Retrieves the module's callbacks instance.
Get container
Container size depending on direction (width or height)
Checks if the module has been destroyed.
If transition in progress
ProtectedmagnetGet nearest magnet
ProtectedmagnetsGet slide magnets
The name of the module, derived from the class name
Optional prefix for classnames used by the module
Current properties. Do not mutate these directly, use updateProps instead.
All slides
Snap track
Protected_addAdds a class name on an element, and keeps track of it for removal when the module is destroyed.
The target DOM element.
The class name to toggle.
Protected_cnHelper function to generate classnames with the module's prefix.
The class names to generate.
A string of class names with the module's prefix applied.
Protected_destroyDestroys the component and clears all timeouts and resources.
Protected_fetchUpdate slides list and attach them
Retrieves the default mutable properties.
Retrieves the default static properties.
Protected_handleHandles properties change
Protected_handleHandle RAF update, interpolate track values
Protected_handleResize the scene and reflow
Protected_reflowReflow: update static values of slides
Protected_renderRender slides logic
Protected_updateUpdate slides values
Protected_updateUpdate slides progress
Cancel sticky behavior
Destroys the module, cleaning up resources, callbacks, and event listeners.
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.
Adds a callback on the module's destruction.
The function to execute during destruction.
Request resize (handled with debounce timeout)
Stick to the nearest magnet
Snap/Carousel handler. This class manages sliding progress with options like swipe, wheel interactions, and smooth transitions.
Please not that the class does not apply any styles to the slides, it only handles the logic.
Documentation