@cullenpu/drift
v1.2.0
Published
A lightweight, dependency-free JavaScript carousel which can be used standalone or as a background.
Downloads
1
Maintainers
cullenpuReadme
Drift is a lightweight, dependency-free, JavaScript carousel which can be used standalone or as a background.
Learn more about Drift here.
Getting Started
Get the latest version with NPM:
npm install @cullenpu/driftLink the library in the <head> section of your HTML code:
<script defer type="text/javascript" src="node_modules/@cullenpu/drift/pub/js/drift.js">Documentation
The full documentation can be found here.
Examples
Drift needs to be mounted on an HTML element. First, set up a <div> where Drift will be mounted.
<div id="my-id">
<h1>Hello World</h1>
<!-- More stuff here -->
</div>Next, make an array containg paths to the desired images and create and render a new Drift.
const myImages = ["img1", "img2", "img3"];
const drift = new Drift("#my-id", myImages);
drift.renderCarousel(0);Custom configurations can also be specified when creating a new Drift, including captions.
const myImages = ["img1", "img2", "img3"];
const myCaptions = ["Caption 1", "Caption 2", "Caption 3"];
const myConfig = {
transitionTimeout: 3000,
random: true,
brightness: 0.55,
captions: myCaptions,
};
const drift = new Drift("#my-id", myImages, myConfig);
drift.renderCarousel(0);