simple-lightbox-gallery
Advanced tools
A modern, accessible, simple lightbox gallery with no dependencies
A modern, accessible lightbox gallery with no dependencies. Perfect for creating responsive image galleries with features like zoom, fullscreen, slideshow, and touch support.
npm install simple-lightbox-gallery
<!-- Add to your HTML head -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.css">
<script src="https://cdn.jsdelivr.net/npm/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.js"></script>
or
<!-- Add to your HTML head -->
<link rel="stylesheet" href="https://unpkg.com/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.css">
<script src="https://unpkg.com/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.js"></script>
import SimpleLightboxGallery from 'simple-lightbox-gallery';
import 'simple-lightbox-gallery/dist/simple-lightbox-gallery.css';
const gallery = new SimpleLightboxGallery({
containerClass: 'gallery',
showCaption: true
});
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.css">
</head>
<body>
<div class="gallery">
<img src="image1.jpg" alt="Image 1">
<img src="image2.jpg" alt="Image 2">
<img src="image3.jpg" alt="Image 3">
</div>
<script src="https://cdn.jsdelivr.net/npm/simple-lightbox-gallery@1.0.0/dist/simple-lightbox-gallery.js"></script>
<script>
document.addEventListener('DOMContentLoaded', function() {
const gallery = new SimpleLightboxGallery({
containerClass: 'gallery'
});
});
</script>
</body>
</html>
| Option | Type | Default | Description |
|---|---|---|---|
containerClass | string | 'gallery' | Class name for the gallery container |
lightboxClass | string | 'lightbox' | Class name for the lightbox element |
animation | string | 'fade' | Animation type ('fade' or none) |
animationSpeed | number | 300 | Animation duration in milliseconds |
infinite | boolean | true | Enable infinite scrolling through images |
showThumbnails | boolean | false | Show thumbnail navigation panel |
showCaption | boolean | true | Show image captions |
captionPosition | string | 'bottom' | Caption position ('top' or 'bottom') |
overlayColor | string | 'rgba(0, 0, 0, 0.9)' | Background color of the lightbox |
zoomEnabled | boolean | true | Enable zoom functionality |
zoomLevel | number | 1.5 | Maximum zoom level |
fullscreen | boolean | true | Enable fullscreen mode |
swipeEnabled | boolean | true | Enable touch swipe navigation |
slideshow | boolean | false | Enable slideshow functionality |
slideshowSpeed | number | 3000 | Slideshow interval in milliseconds |
| Option | Type | Default | Description |
|---|---|---|---|
ariaLabels.gallery | string | 'Image gallery' | ARIA label for gallery |
ariaLabels.lightbox | string | 'Image lightbox' | ARIA label for lightbox |
ariaLabels.close | string | 'Close lightbox' | ARIA label for close button |
ariaLabels.next | string | 'Next image' | ARIA label for next button |
ariaLabels.prev | string | 'Previous image' | ARIA label for previous button |
ariaLabels.zoom | string | 'Toggle zoom' | ARIA label for zoom button |
ariaLabels.fullscreen | string | 'Toggle fullscreen' | ARIA label for fullscreen button |
ariaLabels.slideshow | string | 'Toggle slideshow' | ARIA label for slideshow button |
const gallery = new SimpleLightboxGallery({
containerClass: 'my-gallery',
showThumbnails: true,
showCaption: true,
animation: 'fade',
zoomEnabled: true,
zoomLevel: 2,
fullscreen: true,
slideshow: true,
slideshowSpeed: 5000,
ariaLabels: {
gallery: 'My custom gallery',
lightbox: 'Image viewer'
}
});
| Method | Description |
|---|---|
openLightbox(index) | Opens lightbox at specified image index |
closeLightbox() | Closes the lightbox |
prevImage() | Shows previous image |
nextImage() | Shows next image |
toggleZoom() | Toggles image zoom |
toggleFullscreen() | Toggles fullscreen mode |
toggleSlideshow() | Toggles slideshow |
destroy() | Removes event listeners and cleans up |
| Key | Action |
|---|---|
← | Previous image |
→ | Next image |
Esc | Close lightbox |
F | Toggle fullscreen |
Space | Play/pause slideshow |
Z | Toggle zoom |
| Gesture | Action |
|---|---|
| Swipe left | Next image |
| Swipe right | Previous image |
You can customize the appearance using CSS variables:
:root {
--lightbox-overlay: rgba(0, 0, 0, 0.9);
--lightbox-text: #ffffff;
--control-bg: rgba(0, 0, 0, 0.5);
--control-hover-bg: rgba(0, 0, 0, 0.8);
--thumbnail-size: 60px;
--caption-bg: rgba(0, 0, 0, 0.7);
}
If you want to use this plugin to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Read more about the commercial license.
If you are creating an open source application under a license compatible with the GNU GPL license v3, you may use this project under the terms of the GPLv3.
Raghu Chinnannan
For support, please open an issue in the GitHub repository.
FAQs
A modern, accessible, simple lightbox gallery with no dependencies
The npm package simple-lightbox-gallery receives a total of 57 weekly downloads. As such, simple-lightbox-gallery popularity was classified as not popular.
We found that simple-lightbox-gallery demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.