@gregolive/img-carousel v1.0.2

Image Carousel

A Javascript-powered image carousel/slider. Users can slide the carousel using arrow buttons, select an image with the dot navigation below, or allow the carousel to advance automatically every 5 seconds.

Live demo 👈

npm package 📦

Prerequisites

For icons to display, please install font-awesome.

Installation

On the command line run:

npm i @gregolive/img-carousel

Import the function in your Javascript file with:

import imgCarousel from '@gregolive/img-carousel';

Usage

Pass an array of images to the function.

We recommend using webpack's image loader if using webpack:

import img1 from './img1.jpg';
import img2 from './img1.jpg';

const carousel = imgCarousel([img1, img2]);

Append to the DOM.

document.body.appendChild(carousel);

Default styling (colors, padding, etc.) can be overridden by overriding the CSS variables in:

:root {
  ...
}

License

ISC