@rat.md/bs-lightbox
Advanced tools
A simple Bootstrap 4 and Bootstrap 5 Lightbox system using the native Carousel and Modal components.
bs-lightbox is a simple Lightbox system based on the Bootstrap-native Carousel and Modal components, compatible with Bootstrap 5 and Bootstrap 4.
You can download the latest release of the bs-lightbox package directly on the Release Page of the official GitHub repository, alternatively you can also receive your copy of this script using npm:
npm i @rat.md/bs-lightbox
bs-lightbox does not provide an own stylesheet, instead it just relies on the Bootstrap-native
component and utility classes. Since bs-lightbox does not provide any bundled JS version, you've
to make sure that Bootstrap's JavaScript library is loaded BEFORE the rat.lightbox file.
<html>
<head>
<!-- Include Bootstrap CSS -->
<link href="path/to/your/css/bootstrap.min.css" />
</head>
<body>
<!-- Simple Lightbox -->
<img src="path/to/your/image.jpg" data-bs-handle="lightbox" />
<!-- Include Bootstrap JS -->
<script src="path/to/your/js/bootstrap.bundle.min.js"></script>
<!-- Include @rat.md/bs-lightbox JS -->
<script src="path/to/your/js/rat.lightbox.min.js"></script>
<!-- Invoke Lightbox on all valid components -->
<script>
document.addEventListener('DOMContentLoaded', () => {
rat.Lightbox.invoke();
});
</script>
</body>
</html>
bs-lightbox does also provide an ES-Module version, which can be found in the dist/esm folder.
Depending on how you're including Bootstrap, you probably need to append the Carousel and Modal
prototype objects / classes manually, as shown below.
import { Carousel, Modal } from 'bootstrap'; // Optional, depending on your usage
import { Lightbox } from '../esm/rat.lightbox.min.js';
// The following lines are only necessary, if the 'bootstrap' global is not added
Lightbox.CAROUSEL = Carousel;
Lightbox.MODAL = Modal;
// Go on as usual, make sure the following line is execute when the DOM is ready.
Lightbox.invoke(
null, // Custom or Default selector
{} // Custom Configurations
);
Written and Copyright by rat.md.
Published under der MIT license.
FAQs
A simple Bootstrap 4 and Bootstrap 5 Lightbox system using the native Carousel and Modal components.
The npm package @rat.md/bs-lightbox receives a total of 2 weekly downloads. As such, @rat.md/bs-lightbox popularity was classified as not popular.
We found that @rat.md/bs-lightbox demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.