bs5-lightbox

Lightbox for Bootstrap 5

A lightbox module written in pure ES6 JavaScript for Bootstrap that supports images, galleries, YouTube, Vimeo, and Instagram—built around Bootstrap's Modal and Carousel plugins.

Have you been using Lightbox for Bootstrap (ekko-lightbox) but recently moved to Bootstrap 5? This is your replacement.

Installation

Install with NPM:

npm i bs5-lightbox

Lightbox for Bootstrap 5 will automatically initialize on import:

import 'bs5-lightbox'

By default it will target elements with the data-toggle-"lightbox" attribute.

If you want to target a different element, import the Lightbox class and instantiate it:

import Lightbox from 'bs5-lightbox'

const lightbox = new Lightbox('.my-lightbox-toggle')

If you only want the Lightbox class without automatically initialization, import the module instead:

import Lightbox from 'bs5-lightbox.esm'

const lightbox = new Lightbox('.my-lightbox-toggle')

Contributing

Modify the bs5-lightbox.esm.js file and create a pull request.

You can help make this project even better and keep it up to date by making a small contribution! Fund this project.

Copyright and license

Code released under the MIT license.