bs5-lightbox

Lightbox for Bootstrap 5

A pure JavaScript Bootstrap 5 lightbox 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.

Documentation: https://trvswgnr.github.io/bs5-lightbox/

Installation

Install with NPM:

npm i bs5-lightbox

CDN:

<script src="https://cdn.jsdelivr.net/npm/bs5-lightbox@1.6.5/dist/index.bundle.min.js"></script>

Or download the file directly (right-click, Save As...)

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'

document.querySelectorAll('.my-lightbox-toggle').forEach((el) => el.addEventListener('click', (e) => {
	e.preventDefault();
	const lightbox = new Lightbox(el);
	lightbox.show();
}));

Contributing

Lightbox for Bootstrap 5 is written in TypeScript and compiled to pure JavaScript. Modify the src/index.ts file, run npm run build 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.