super-simple-jquery-slideshow v1.0.2

Super Simple jQuery Slideshow

Congratualtions! You've encountered one of the simplest (and possible most fragile) jQuery gallery slider plugins in this section of our galaxy.

This plugin will give you an image gallery sliding functionality by wrapping a div, with an id of gallery, with however many img tags you have inside it, and provide buttons to shuffle through the images.

Install:

  $ npm install super-simple-jquery-slideshow

Set up your images inside the div:

<div id="gallery">
  <img src="image1" alt="text" />
  <img src="image2" alt="text" />
  <img src="image3" alt="text" />
</div>

(This plugin is of course dependant on jQuery!)

Inside your index.js (or wherever you may see fit):

import $ from 'jquery';
import 'super-simple-jquery-slideshow/slideshow.css';
import 'super-simple-jquery-slideshow';

window.jQuery = $;

$('document').ready(function() {
  $('#gallery').slideShow();
});

You need to import the css file slideshow.cssin order to get the correct behaviour. It will position the images absolute and hide the non-active images.

THIS IS ENOUGH TO GET THE SLIDER UP AND RUNNING.

This is the result in html:

<div id="gallery" class="_slideshow-gallery">
  <div class="_slideshow-gallery__image-container ">
    <div class="_slideshow-gallery__image-container-inner ">
      <img src="image1" alt="text" class="_slideshow-gallery__image" /><img
        src="image2"
        alt="text"
        class="_slideshow-gallery__image"
      /><img src="image3" alt="text" class="_slideshow-gallery__image" />
    </div>
  </div>

  <div class="_slideshow-gallery__slider ">
    <button id="_slideshow-gallery__prev-btn" class="">Previos</button>
    <button id="_slideshow-gallery__next-btn" class="">Next</button>
  </div>
</div>

It's not very impressive at first:

But you get to add classes to each of the added elements through an options object. Each class name represents an object key: | Element | Class name | |--------------------------------------------|---------------------| | #gallery | galleryClass | | ._slideshow-galleryimage-container | containerClass | | ._slideshow-galleryimage-container-inner | innerContainerClass | | ._slideshow-galleryslider | buttonMenu | | ._slideshow-galleryprev-btn | prevBtnClass | | ._slideshow-gallery__next-btn | nextBtnClass | |