Methods

All public methods available on a Slider instance.

Navigation

MethodDescription
slider.goTo(target)Navigate to a slide. Target can be a number (index), 'next', 'prev', 'first', or 'last'.
slider.next()Go to next slide. Shorthand for goTo('next').
slider.prev()Go to previous slide. Shorthand for goTo('prev').

Autoplay proxy

MethodDescription
slider.play()Start autoplay. Requires the autoplay plugin.
slider.pause()Pause autoplay. Requires the autoplay plugin.

State

MethodDescription
slider.update()Recalculate layout. Useful after DOM mutations (adding/removing slides).
slider.updateSliderHeight()Force a height recalculation based on the active slide (useful with autoHeight).
slider.getInfo()Returns a full snapshot of the slider state as a plain object.
slider.enable()Enable the slider (unfreezes and un-disables).
slider.disable()Disable the slider (pointer-events off, visual opacity).

Lifecycle

MethodDescription
slider.destroy()Full teardown. Removes clones, event listeners, plugins, ARIA attributes, and inline styles.
slider.rebuild(opts?)Calls destroy() then creates a new slider with the same (or merged) options. Returns the new instance.

Events (post-init)

// Add listener after init
slider.on('afterSlideChange', ({ index }) => {
  console.log('Active:', index)
})

// Remove it later
slider.off('afterSlideChange', myHandler)

Plugin access

import { mouseWheel } from '@andresclua/sliderkit-plugins'

// Register a plugin after init
slider.use(mouseWheel())

Getters

GetterTypeDescription
slider.activeIndexnumberCurrent active slide index.
slider.previousIndexnumberPreviously active slide index.
slider.slidesHTMLElement[]Array of original slide elements (no clones).
slider.slideCountnumberNumber of original slides.
slider.isBeginningbooleanTrue when at the first slide.
slider.isEndbooleanTrue when at the last slide (or last page).
slider.progressnumberProgress from 0 (first) to 1 (last).
slider.isDestroyedbooleanTrue after destroy() was called.
slider.isOnbooleanTrue when active (not destroyed, frozen, or disabled).
slider.containerHTMLElementThe container element.
slider.wrapperHTMLElementThe wrapper element (slides parent).
slider.versionstringLibrary version string.