Karavai JS
KaravaiJS - Images sequence scrolling engine with no dependencies
Demo
Installation
CDN
UMD
yarn add --exact karavai
npm install --save-exact karavai
Usage
// import package. You can miss this step for CDN installation; const images = ...;const canvasRef = document; const karavai = images canvasRef; async { await karavai karavaistart}
Configuration
Options
const options = // Number // images change threshold in pixels. // Means: every N pixels, update image to the next one // Default: 30 threshold: 30;const karavai = images canvasRef options;karavaistart;
API
preloadImages - preloads provided amount of images. Default: all images. Returns: Promise. Preload is not required, but strongly recommended
const karavai = images canvasRef;karavai; // -> Promise
start - start karavai. It will start logic which updates images on scroll.
const karavai = images canvasRef;karavaistart;
stop - stop karavai. It will stop logic which updates images on scroll.
const karavai = images canvasRef;karavai;
License
Karavai.js is freely distributable under the terms of the MIT license.