History

Denys Konovalov 3553bff998 Initial commit		2023-12-30 22:34:25 +01:00
..
dist	Initial commit	2023-12-30 22:34:25 +01:00
src	Initial commit	2023-12-30 22:34:25 +01:00
CHANGELOG.md	Initial commit	2023-12-30 22:34:25 +01:00
composer.json	Initial commit	2023-12-30 22:34:25 +01:00
LICENSE	Initial commit	2023-12-30 22:34:25 +01:00
package.json	Initial commit	2023-12-30 22:34:25 +01:00
README.md	Initial commit	2023-12-30 22:34:25 +01:00

README.md

VenoBox

Responsive modal window javaScript plugin, touch swipe gallery

Just another responsive lightbox plugin, suitable for images, inline contents, iFrames, videos.

The big difference compared to many others plugins is that VenoBox calculates the max width of the image displayed and preserves its height if is taller than the window (so in small devices you can scroll down the content, avoiding vertical microscopic resized images).

Demo: https://veno.es/venobox/

Quick start

Install

This package can be installed with:

npm: npm install venobox
composer: composer require nicolafranchini/venobox

Static HTML

Download the latest release or get the sources from jsDelivr

Put the required stylesheet into your <head> to load our CSS:

<link rel="stylesheet" href="venobox/dist/venobox.min.css" />

Include the script near the end of your pages, right before the closing </body> tag:

<script src="venobox/dist/venobox.min.js"></script>

Usage

Insert one or more links with a custom class

<a class="venobox" href="image01-big.jpg"><img src="image01-small.jpg" alt="image alt"/></a>

Initialize the plugin and your VenoBox is ready for all the selected links.

new VenoBox({
  selector: '.venobox'
});

Documentation

The full documentation is available at https://veno.es/venobox/

License: released under the MIT License