Skip to content
🎃 Minimalist image lightbox
CSS JavaScript HTML
Branch: master
Clone or download
Latest commit 0079647 Jan 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Updated docs Dec 19, 2016
example updated docs and example Dec 22, 2016
lib Use elly to create elements Dec 19, 2016
.gitignore Updated docs Sep 8, 2017
CONTRIBUTING.md Updated docs Apr 26, 2016
DOCUMENTATION.md Updated docs Sep 8, 2017
LICENSE Updated docs Jan 3, 2019
README.md Updated docs Jan 3, 2019
package.json Updated docs Jan 3, 2019

README.md

mini-lightbox

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Minimalist image lightbox

Demo

Check out the demo page.

Browser support

As long the CSS3 transitions are supported by your browser, this should work fine. 🚀

Examples

Simple usage

<img id="myImage" src="myImage.png" alt="Some title">
<script>
    new MiniLightbox("#myImage");
</script>

Advanced usage

If you need more stuff (e.g. animations etc), you need to create custom handlers (customClose and customOpen handlers). Works like a charm with animate.css library. 😄

function waitForAnimationEnd(element, callback) {
    var animationEnd = "animationend";
    var handleAnimationEnd = function(event) {
      // remove listner
      event.target.removeEventListener(animationEnd, handleAnimationEnd);
      // fire callback
      return callback(event);
    };
    element.addEventListener(animationEnd, handleAnimationEnd);
}

MiniLightbox.customClose = function(self) {
    self.img.classList.add("animated", "fadeOutDown");
    waitForAnimationEnd(self.img, function() {
      self.box.classList.add("animated", "fadeOut");
    });
    waitForAnimationEnd(self.box, function() {
      self.box.classList.remove("animated", "fadeOut", "fadeIn");
      self.img.classList.remove("animated", "fadeOutDown");
      self.box.style.display = "none";
    });
    return false;
};

MiniLightbox.customOpen = function(self) {
    if (self.el.parentElement.tagName === "A") {
      return false;
    }
    self.box.classList.add("animated", "fadeIn");
    self.img.classList.add("animated", "fadeInUp");
};

Using data-image-opened attribute

If data-image-opened attribute is provided in img element, it will be used for the path of the image when the popup is opened.

<img id="myImage" data-image-opened="./big.png" src="small.png" alt="Some title">

Delegation

If images are added dynamically, you need to use delegation:

new MiniLightbox({
    selector: ".content img"
    // the common container where the images are appended
  , delegation: "html"
});

☁️ Installation

Check out the dist directory to download the needed files and include them on your page.

If you're using this module in a CommonJS environment, you can install it using npm or yarn and require it:

# Using npm
npm install --save mini-lightbox

# Using yarn
yarn add mini-lightbox

📝 Documentation

MiniLightbox(options)

Initializes the lightbox according to the options.

Callbacks:

The following methods can be used to modify the default behavior:

  • Minilightbox.customOpen (Function): If it's a function, it will be called then the lightbox is opened. If it returns false, the default behavior will be prevented.
  • Minilightbox.customClose (Function): If it's a function, it will be called then the lightbox is closed. If it returns false, the default behavior will be prevented.

Params

  • Object options: An object containing the following fields:
  • selector (String): The image query selector.
  • delegation (String): The image container where to handle the delegation.

close(id)

Closes the lightboxes.

Params

  • String id: The lightbox id. If not provided, it will close all the opened lightboxes.

open(id)

Opens the lightbox. This is called internally.

Params

  • String id: The lightbox id.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list.

📜 License

MIT © Ionică Bizău

You can’t perform that action at this time.