API Methods

ContinuousCarousel() is a factory function that returns a carousel instance with methods and properties.

const carousel = ContinuousCarousel('myCarousel', options);

Methods

play()

Resume carousel animation. Fires the onPlay callback if set.

carousel.play();

pause()

Pause carousel animation. Fires the onPause callback if set.

carousel.pause();

destroy()

Stop the carousel and clean up all event listeners, observers, and DOM modifications. Fires the onDestroy callback if set.

carousel.destroy();

WARNING

After calling destroy(), the carousel instance can no longer be used. You must create a new instance to restart it.

goToSlide(index)

Jump to a specific slide by 0-based index. Snaps instantly to the target position, then resumes animation from there. Fires onSlideChange and onSlideEnd callbacks.

carousel.goToSlide(0); // first slide
carousel.goToSlide(2); // third slide

updateConfig(options)

Update configuration options on a running carousel. Accepts a partial options object.

carousel.updateConfig({
  interval: 5000,
  pauseOnHover: true
});

Properties

container

The carousel's root DOM element.

carousel.container; // HTMLElement

config

The current configuration object (read-only reference).

carousel.config.interval;   // 2000
carousel.config.direction;  // 'horizontal'

Example

const carousel = ContinuousCarousel('myCarousel', {
  interval: 3000,
  pauseOnHover: true,
  onSlideChange: (index, element) => console.log('Slide:', index, element)
});

// Jump to third slide
carousel.goToSlide(2);

// Pause after 10 seconds
setTimeout(() => carousel.pause(), 10000);

// Update speed
carousel.updateConfig({ interval: 1000 });

// Clean up when done
carousel.destroy();