saga-gallery v0.2.0

Saga Gallery

Saga Gallery is a simple and small lightbox gallery written in pure JavaScript.

• No dependencies required
• Simple API
• No extra files to download

Installation

Bower

bower install saga-gallery --save

NPM

npm install saga-gallery --save

Include the saga-gallery CSS style in your head tags.

<link rel="stylesheet" href="dist/saga-gallery.min.css">

Include the saga-gallery script in your head tags or right before your body closing tag.

<script src="dist/saga-gallery.min.js"></script>

Usage

HTML

The Gallery is an unordered list. A li with the class of selected specifies the element which is displayed. If none is specified the first element will be used. Upon clicking the image the lightbox gallery opens.

<ul id="foo">
    <li>
        <img src="http://placehold.it/350x350/2ecc71/ecf0f1" alt="Image 1">
        <div class="saga-description"><h3>Lorem</h3><p>Ipsum dolor sit amet</p></div>
    </li>
    <li><img src="http://placehold.it/350x350/3498db/ecf0f1" alt="Image 2"></li>
    <li><img src="http://placehold.it/350x350/e67e22/ecf0f1" alt="Image 3"></li>
    <li><img src="http://placehold.it/350x350/e74c3c/ecf0f1" alt="Image 4"></li>
</ul>

Use The Plugin

Bind the gallery to a container element with id of foo

// instanciate new gallery
var gallery = new SagaGallery('foo', {
    onOpen: function() {
        console.log('gallery open');
    },
    onClose: function() {
        console.log('gallery closed');
    },
    loop: false
});

// open gallery
gallery.open();

// close gallery
gallery.close();

// check if gallery is opened
if (gallery.isOpen()) 
    // do something ...

// display next image
gallery.next();

// display prev image
gallery.prev();

Options

Default Options

{
    onClose: null, // called after closing
    onOpen: null,  // called after opening
    loop: true     // true will return to the first image after the last image is reached
}

API