Methods

All public methods available on a Slider instance.

Navigation

MethodDescription
goTo(target) Navigate to a slide. target can be a number (0-based index), 'next', 'prev', 'first', or 'last'.
next()Go to the next slide. Shorthand for goTo('next').
prev()Go to the previous slide. Shorthand for goTo('prev').
const slider = new Slider('#my-slider', { loop: true })

slider.next()
slider.prev()
slider.goTo(2)       // jump to slide 3 (0-based)
slider.goTo('last')  // jump to last slide

Events

MethodDescription
on(event, fn)Subscribe to a slider event. fn receives a SliderInfo object.
off(event, fn)Unsubscribe the exact same function reference.
emit(event, data?)Manually emit an event on this slider instance.
function onChanged(info) {
  console.log('active slide:', info.displayIndex)
}

slider.on('indexChanged', onChanged)

// later
slider.off('indexChanged', onChanged)

Info

MethodDescription
getInfo()Returns a SliderInfo snapshot of the current slider state.

Lifecycle

MethodDescription
destroy()Full teardown — removes clones, event listeners, injected CSS, ARIA attributes, and calls each plugin's destroy().

Properties

PropertyTypeDescription
activeIndexnumberCurrent 0-based slide index.
currentItemsnumberCurrently active items count (respects responsive breakpoints).
slideCountnumberTotal number of real slides (no clones).
isBeginningbooleantrue when on the first slide.
isEndbooleantrue when on the last slide.
containerHTMLElementThe user's original container element.
outerWrapperHTMLElementThe outer wrapper injected by the slider.
innerWrapperHTMLElementThe inner wrapper (applies edge padding).
slidesHTMLElement[]All slide elements including clones.
optionsRequired<SliderOptions>Merged options object (base only, not responsive overrides).