scroll-to-play v1.1.0

ScrollToPlay

animate images on scroll

Installation

run npm i scroll-to-play or yarn add scroll-to-play

Usage

• import library:

import ScrollToPlay from '../scroll-to-play/scroll-to-play'

• create array with image urls:

const images = [
  'path/to/image1.jpg',
  'path/to/image2.jpg',
  // ...
  'path/to/imageX.jpg',
]

• create img and initialize ScrollToPlay with its id:

// <div><img id="image-animated"></div>
// ...
const stp = new ScrollToPlay({
  imageElementId: 'image-animated',
  imageSrcs: images,
})

this is minimal configuration. other possible options are:

{
  imageElementId: 'image-animated',
  imageSrcs: images,
  // optional with defaults:
  preloadImagesOnLoad: true,
  showPreloadProgress: true,
  preloadProgressColor: '#dadada',
  fromPx: 0,
  fromPercent: 0,
  toPx: 0,
  toPercent: 1,
  autoplay: false,
  verbose: false,
}