Glightbox is a pure javascript lightbox. It can display images, iframes, inline content and videos with optional autoplay for youtube, vimeo and even self hosted videos.

• Small - only 11KB Gzipped
• Responsive - works with any screen size
• Gallery Support - Create multiple galleries
• Video Support - Youtube, Vimeo and self hosted videos with autoplay
• Inline content support - display any inline content
• Iframe support - need to embed an iframe? no problem
• Keyboard Navigation - esc, arrows keys, tab and enter is all you need
• Touch Navigation - mobile touch events
• Zoomable images - zoom and drag images on mobile and desktop
• Api - control the lightbox with the provided methods
• Customizable - create your skin or modify the animations with some minor css changes

You can check the live demo right here

$ npm install glightbox
# OR
$ yarn add glightbox
# OR
$ bower install glightbox

import GLightbox from 'glightbox'

Or manually download and link glightbox.min.js in your HTML:

<link rel="stylesheet" href="dist/css/glightbox.css">
<script src="dist/js/glightbox.min.js"></script>

OR CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/glightbox/dist/css/glightbox.min.css">
<script src="https://cdn.jsdelivr.net/gh/mcstudios/glightbox/dist/js/glightbox.min.js"></script>

<script type="text/javascript">
    const lightbox = GLightbox({ ...options });
</script>

<!-- Simple image -->
<a href="large.jpg" class="glightbox">
    <img src="small.jpg" alt="image">
</a>

<!-- Video -->
<a href="https://vimeo.com/115041822" class="glightbox2">
    <img src="small.jpg" alt="image">
</a>

<!-- Gallery -->
<a href="large.jpg" class="glightbox3" data-gallery="gallery1">
    <img src="small.jpg" alt="image">
</a>
<a href="video.mp4" class="glightbox3" data-gallery="gallery1">
    <img src="small.jpg" alt="image">
</a>

<!-- Simple Description -->
<a href="large.jpg" class="glightbox4" data-glightbox="title: My title; description: this is the slide desciption">
    <img src="small.jpg" alt="image">
</a>

<!-- Advanced Description -->
<a href="large.jpg" class="glightbox5" data-glightbox="title: My title; description: .custom-desc1">
    <img src="small.jpg" alt="image">
</a>

<div class="glightbox-desc custom-desc1">
    <p>The content of this div will be used as the slide description</p>
    <p>You can add links and any HTML you want</p>
</div>

You can specify some options to each individual slide, the available options are:

• title
• description
• descPosition
• type
• effect
• width
• height

<!-- One line config -->
<a href="large.jpg" data-glightbox="title: Your title; description: desciption here; descPosition: left; type: image; effect: fade; width: 900px; height: auto;"></a>

<!-- Multiple data attributes / You can use the options as separated data attributes -->
<a href="large.jpg" data-title="My title" data-description="desciption here" data-descPosition="right" data-type="image" data-effect="fade" data-width="900px" data-height="auto"></a>

Example use of the options.

const lightbox = GLightbox({
    touchNavigation: true,
    loopAtEnd: true,
    autoplayVideos: true,
    onOpen: () => {
        console.log('Lightbox opened')
    },
    beforeSlideLoad: (slide, data) => {
        // Need to execute a script in the slide?
        // You can do that here...
    }
});

// Instead of using a selector, define the gallery elements
const myGallery = GLightbox({
    elements: [
        {
            'href': 'https://picsum.photos/1200/800',
            'type': 'image',
            'title': 'My Title',
            'description': 'Example',
        },
        {
            'href': 'https://picsum.photos/1200/800',
            'type': 'image'
        },
        {
            'href': 'https://www.youtube.com/watch?v=Ga6RYejo6Hk',
            'type': 'video',
            'source': 'youtube', //vimeo, youtube or local
            'width': 900,
        }
    ],
    autoplayVideos: true,
});
myGallery.open();

// If later you need to modify the elements you can use setElements
myGallery.setElements([...]);

Starting from version 2.0.2 glightbox droped support of JWPlayer because that player implemented new restrictions for the free edition, it was replaced with an awesome new player "Plyr" that also includes support for youtube and vimeo. So instead of maintaining 3 different apis now we only can focus on one. You can pass any Plyr option to the player, view all available options here Plyr options.

Please note that GLightbox will only inject the video player library if required and only when the lightbox is opened.

const lightbox = GLightbox({
    plyr: {
        css: 'https://cdn.plyr.io/3.5.6/plyr.css', // Default not required to include
        js: 'https://cdn.plyr.io/3.5.6/plyr.js', // Default not required to include
        config: {
            muted: false,
            hideControls: true,
            youtube: {
                noCookie: true,
                rel: 0,
                showinfo: 0,
                iv_load_policy: 3
            },
            vimeo: {
                byline: false,
                portrait: false,
                title: false,
                speed: true,
                transparent: false
            }
        }
    }
});

There are methods, setters and getters on a GLightbox object. The easiest way to access the GLightbox object is to set the return value from your call to a variable. For example:

const lightbox = GLightbox({...options});

Example method use:

lightbox.nextSlide(); // Go to next slide
lightbox.close(); // Close de lightbox

// Example set custom gallery items
lightbox.setElements([
  {
    'href': 'https://picsum.photos/1200/800',
    'type': 'image'
  },
  {
    'href': 'https://www.youtube.com/watch?v=Ga6RYejo6Hk',
    'type': 'video',
    'source': 'youtube', //vimeo, youtube or local
    'width': 900,
  }
]);
// Open the lightbox
lightbox.open();

$ npm install
$ npm run watch

GLightbox was tested in the following browsers.

• Safari
• Mobile Safari
• Opera
• Edge
• Firefox
• Internet Explorer 11

It will work in any browser that supports css Flexbox

Feel free to report any issues! If you wish to contribute by fixing a bug or implementing a new feature, please first read the CONTRIBUTING guide.

• Fixed some errors when zooming and dragging images
• Fixed description position not respected when configured globally
• Fixed local videos not resized correctly when entered fullscreen

• New: Zooming images. Now you can zoom images on desktop if image is too large
• New: Now you can also define the slide description using the content of any div you want.
• New: Replaced png icons with svg and added options to customize them.
• Fixed responsive videos not resizing correctly when resizing the window vertically
• Fixed responsive images not resizing correctly if they have description and the window height is lower that the slide height
• Fixed youtube video not detected correctly for urls like youtube(-nocookie).com/embed/...

• New: Plyr player, we have changed to this player so that way only one api is managed instead of 3
• New: Added tabindex accesibility to loop the controls with the tab key
• New: Inside inline content you can close the lightbox by adding the class gtrigger-close to any element
• Fixed StartAt not taking specified index
• Removed JWPlayer because that player implemented some restrictions unless you pay for a license
• Improved mobile touch events, swipe, move, zoom, etc.
• Changed: Youtube now by default uses youtube-nocookie.com, you can enable cookies in the config with youtube.nocookie to false
• Removed option videosHeight. The height is automatic depending the video width and ratio.
• Removed Gulp and replaced for pure nodejs scripts
• Improved documentation

• Fixed Mobile navigation
• Fixed slide width for external sources

• New: Delegated permissions to cross-origin iframes (for the new browsers autoplay restrictions)
• Fixed youtube, vimeo autoplay when changing slides
• Fixed lightbox won't fit screen with description
• Fixed Removed global body variable that was causing some problems

• Added svg to source types so it can be displayed as an image @tuomassalo
• Added contributing file
• Updated dependencies @tuomassalo.
• Removed demo folder from npm

• New: You can define each slide option in a different data attribute (data-title="example" data-description="...")
• Fixed youtube and vimeo autoplay when opened for the first time
• Fixed global slide params not working
• Fixed some issues on IE11
• Fixed using characters : or ; in slide description

• New: Added reload method, useful when injecting content with ajax, cloning nodes, etc.
• Fixed closeButton setting not removing the element
• Fixed video not displayed on mobile devices

• New: Now you can set individual width and height for each slide with inlines or iframes.
• New: Now you can set individual source types for each slide ('type': 'image' | 'iframe' | 'video' | 'inline' | 'external).
• New: Published on npm
• New: Published on bower
• Fixed afterSlideLoad only triggered one time for all the slides
• Fixed a small space between the image and description when is set to top or bottom

• New: Added none as a new option to disable open, close and slide animations
• New: Added new options (touchNavigation, keyboardNavigation, closeOnOutsideClick) to enable or disable user interaction
• Fixed open and close effect not taking a custom animation
• Fixed an error when calling the destroy method and no videos were present in the slider

• Improved the open method so it can be called without duplicating the structure and events
• New: The original node is passed to events like beforeSlideChange, afterSlideChange, etc.

• New: Added option moreLength to control the number of characters in the description for mobile devices

• Fixed instance not returned and unable to call public methods

• Fixed large images not displayed correctly

• Initial release

This project is licensed under the MIT License - see the LICENSE.md file for details