Skip to content

Mersmith/glider-autoplay

 
 

Repository files navigation

glider-autoplay

Autoplay utility for Glider.js

See example in index.html

Copy file glider-autoplay.min.js and include to your html

<script src="glider-autoplay.min.js"></script>

Or install with npm

npm i glider-autoplay
import { gliderAutoplay } from "glider-autoplay";

Usage

gliderAutoplay(
  new Glider(/* see glider-js docs*/),
  {
    interval, // int, required
    pausable, // boolean, default true
    onPause,
    onRestart,
    startItem // default 0
  }
);

interval - interval between slides in milliseconds;
pausable - autoplay will be stopped onMouseEnter and rerun onMouseLeave when true
onPause - callback function to be called when autoplay stopped
onRestart - callback function to be called when autoplay run
startItem - glider item with which autoplay will start


Methods

pause()

const gliderInstance = new Glider(/* see glider-js docs*/);
gliderAutoplay(gliderInstance, {interval: 3000});
gliderInstance.pause();

run()

const gliderInstance = new Glider(/* see glider-js docs*/);
gliderAutoplay(gliderInstance, {interval: 3000});
gliderInstance.run();

Properties

isRunning //boolean

const gliderInstance = new Glider(/* see glider-js docs*/);
gliderAutoplay(gliderInstance, {interval: 3000});
console.log(gliderInstance.isRunning) // true

gliderInstance.pause();
console.log(gliderInstance.isRunning) // false

gliderInstance.run();
console.log(gliderInstance.isRunning) // true

Releases

No releases published

Packages

No packages published

Languages

  • HTML 79.6%
  • JavaScript 20.4%