Methods
All public methods available on a Slider instance.
Navigation
| Method | Description |
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
| Method | Description |
slider.play() | Start autoplay. Requires the autoplay plugin. |
slider.pause() | Pause autoplay. Requires the autoplay plugin. |
State
| Method | Description |
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
| Method | Description |
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
| Getter | Type | Description |
slider.activeIndex | number | Current active slide index. |
slider.previousIndex | number | Previously active slide index. |
slider.slides | HTMLElement[] | Array of original slide elements (no clones). |
slider.slideCount | number | Number of original slides. |
slider.isBeginning | boolean | True when at the first slide. |
slider.isEnd | boolean | True when at the last slide (or last page). |
slider.progress | number | Progress from 0 (first) to 1 (last). |
slider.isDestroyed | boolean | True after destroy() was called. |
slider.isOn | boolean | True when active (not destroyed, frozen, or disabled). |
slider.container | HTMLElement | The container element. |
slider.wrapper | HTMLElement | The wrapper element (slides parent). |
slider.version | string | Library version string. |