README

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

JavaScript Setup

Import the module and initialize.

import VenoBox from 'venobox';

CSS Setup

Include the stylesheet separately in your CSS entry point or HTML head.

via CSS (@import):

@import "venobox/dist/venobox.min.css";

or via HTML (<link>):

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

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

nicolafranchini / venobox

Maintainers

Package info

Statistics

Security