InternalInternalRetrieves the module's callbacks instance.
Indicates whether the instance has been destroyed.
After destruction, destroy is a no-op.
Not swiping, wheeling, interpolating, or transitioning.
True when an oversized active slide is scrolled inside the container.
The name of the module, derived from the class name
Optional prefix for classnames used by the module
0…1 when not looping; unbounded when loop is enabled.
Current properties. Do not mutate these directly, use updateProps instead.
Slides larger than the container (supports inner scroll within a slide).
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_destroyReleases resize observers, animation loop, slides (parallax, slide resize), and input handlers (swipe, wheel, interval, keyboard).
Protected_emitEmits a callback event with a fixed payload.
Set default mutable props
Container size. Supported values:
auto detects slide size depending on the container size.number defines the slide size in pixels.px, rem, vw, vh, svh.Sliding direction
Change slide duration
Easing type for timelines
Maximum friction between the final slide and the maximum translation value. From 0 to 1. The higher value the more resistance is applied.
If disabled, then slider will be animated only when you release the finger, it will not move while you hold your finger on it.
If false, disables smooth, continuous scrolling behavior from the mouse wheel
and instead updates the snap position in discrete steps (like pagination).
Enables freemode, with or without sticky magnets.
Friction that makes the slides tend to the nearest slide magnet. The value is a number between 0 and 1
which is multiplied by the lerp value.
0 disables friction
The gap between slides. Supports css units like px, rem, vw, vh, svh.
User will see the "grab" cursor when hovering and "grabbing" when swiping
Interval between automatic slide changes in milliseconds. If null, the interval is disabled.
Direction of automatic slide changes. Can be either 'next' or 'prev'.
Linear interpolation factor for smooth coordinates updates.
Detects if need to loop the progress
Slide magnet origin
Prevents the browser default wheel action, such as page scroll.
Enables wrap-around navigation: advancing from the last slide jumps to the first,
and going back from the first jumps to the last. Has no effect when loop mode is enabled.
When true, swipes shorter than shortSwipeDuration can trigger slide change.
Short swipes work only when followSwipe is true.
Short swipe maximum duration
Minimum distance in pixels to trigger slide change for short swipes
Slides instances. If false, all container's children will be considered as slides.
Slide size. Supported values:
auto detects slide size depending on the element or container size.stretch detects slide size as the container size.number defines the slide size in pixels.px, rem, vw, vh, svh.Indicates the number of slides to scroll on swipe or wheel.
Snap to the nearest slide on carousel resize
Enable snapping on wheel stop. Works with followWheel enabled.
Snapping threshold for stickOnWheelEnd
Enable or disable swipe events
Swipe axis
Defines if friction is allowed when swiping. Doesn't work with short swipes or when when followSwipe is false
Inertia strength.
Minimum time in milliseconds to trigger swipe move.
Speed factor for swipe movements.
Length in pixels that must be swiped to trigger swipe start.
Enable or disable mouse wheel events for progress control
Wheel axis
Speed factor for mouse wheel movements
Throttle wheel events, value in milliseconds.
Works only if followWheel is disabled.
auto — automatic detection when followWheel is disablednumber — value in millisecondsGet default static props
Default active index
HTML container
HTML Element used to emit events
Protected_handleMethod that is called when the module's properties mutate. In most cases, used to handle callbacks.
Optionaldata: ISnapNexPrevArgAdds 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).
Optionaldata: ISnapNexPrevArgOptionaloptions: ISnapTransitionArgOptionaldata: ISnapToSlideArg
Low-level carousel handler for slide progress, snapping, and interaction.
updatecallbackDocumentation