Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.85 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.85 KB
Raw

VenoBox

Responsive jQuery modal window plugin

Just another responsive jQuery lightbox plugin, suitable for images, inline contents, iFrames, Google Maps, Vimeo and YouTube videos.

The big difference compared to many others plugins like this 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: http://veno.es/venobox/

Quick start

Install

This package can be installed with:

  • npm: npm install venobox
  • bower: bower install venobox
  • composer: composer require nicolafranchini/venobox
  • yarn: yarn add venobox

Or download the latest release.

Static HTML

Put the required stylesheet at the top of your markup:

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

Put the script at the bottom of your markup right after jQuery:

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

Usage

Insert one or more links with its custom class

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

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

$(document).ready(function(){
  $('.venobox').venobox(); 
});

Documentation

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

License: released under the MIT License