# VenoBox
[](https://www.npmjs.com/package/venobox)
[](https://www.npmjs.com/package/venobox)
[](https://www.jsdelivr.com/package/npm/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](https://www.npmjs.com/package/venobox): `npm install venobox`
- [composer](https://packagist.org/packages/nicolafranchini/venobox): `composer require nicolafranchini/venobox`
#### JavaScript Setup
Import the module and initialize.
```code
import VenoBox from 'venobox';
```
#### CSS Setup
Include the stylesheet separately in your CSS entry point or HTML head.
**via CSS (@import):**
```code
@import "venobox/dist/venobox.min.css";
```
**or via HTML (``````):**
```html
```
### Static HTML
Download the [latest release](https://github.com/nicolafranchini/VenoBox/releases)
or get the sources from [jsDelivr](https://cdn.jsdelivr.net/npm/venobox@latest/dist/)
Put the required stylesheet into your `` to load our CSS:
```html
```
Include the script near the end of your pages, right before the closing `` tag:
```html
```
### Usage
Insert one or more links with a custom class
```html
```
Initialize the plugin and your VenoBox is ready for all the selected links.
```javascript
new VenoBox({
selector: '.venobox'
});
```
## Documentation
The full documentation is available at https://veno.es/venobox/
License: released under the MIT License
