bs5-lightbox
    TypeScript icon, indicating that this package has built-in type declarations

    1.8.0 • Public • Published

    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/

    If you enjoy using Bootstrap 5 Lightbox please star this repo.

    Status

    github latest release jsdelivr hits per month npm downloads npm minzipped size npm version Libraries.io dependency status for latest release Featured on Openbase

    Installation

    Install with NPM:
    npm i bs5-lightbox
    CDN:
    <script src="https://cdn.jsdelivr.net/npm/bs5-lightbox@1.8.0/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.

    Install

    npm i bs5-lightbox

    DownloadsWeekly Downloads

    784

    Version

    1.8.0

    License

    MIT

    Unpacked Size

    69.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • trvswgnr