Senangwebs-gallery NPM

SenangWebs Gallery (SWG)

SenangWebs Gallery (SWG) is a lightweight JavaScript library that provides a modern, responsive modal image gallery with smooth transitions and intuitive navigation. With minimal setup, you can transform your image collections into an engaging gallery experience, complete with captions and keyboard controls.

Features

Easy to integrate with existing projects
Responsive modal gallery with smooth transitions
Support for image captions
Keyboard navigation support (arrow keys and escape)
Counter display option for tracking image position
Touch-friendly navigation controls
Customizable via data attributes
No external dependencies
Efficient performance
Works on all modern browsers

Installation

Using npm

npm install senangwebs-gallery

Using a CDN

You can include SenangWebs Gallery directly in your HTML file using unpkg:

<link rel="stylesheet" href="https://unpkg.com/senangwebs-gallery@latest/dist/swg.css">
<script src="https://unpkg.com/senangwebs-gallery@latest/dist/swg.js"></script>

Usage

Include the SWG CSS and JavaScript files in your HTML:

<!-- If installed via npm -->
<link rel="stylesheet" href="path/to/swg.css">
<script src="path/to/swg.js"></script>

<!-- Or if using unpkg -->
<link rel="stylesheet" href="https://unpkg.com/senangwebs-gallery@latest/dist/swg.css">
<script src="https://unpkg.com/senangwebs-gallery@latest/dist/swg.js"></script>

Create your gallery structure using data attributes:

<div data-swg data-swg-page>
    <div data-swg-item data-swg-caption="Beautiful sunset">
        <img src="path/to/image1.jpg" alt="Sunset">
    </div>
    <div data-swg-item data-swg-caption="Mountain view">
        <img src="path/to/image2.jpg" alt="Mountain">
    </div>
    <div data-swg-item data-swg-caption="Ocean waves">
        <img src="path/to/image3.jpg" alt="Ocean">
    </div>
</div>

The gallery will automatically initialize when the page loads.

Data Attributes

Configure your gallery using these data attributes:

data-swg: Marks the container element as a gallery
data-swg-page: Enables the counter display showing current image position (e.g., "2 / 5")
data-swg-item: Marks an element as a gallery item
data-swg-caption: Adds a caption to the image in the modal view

Features in Detail

Navigation

Keyboard Controls:
- Left Arrow: Previous image
- Right Arrow: Next image
- Escape: Close modal
Mouse/Touch Controls:
- Click on image: Open modal
- Click overlay: Close modal
- Previous/Next buttons: Navigate between images
- Close button: Exit modal view