wa-mediabox
v1.0.1
Published
Modern lightbox without jQuery and with iframe support.
Downloads
295
Maintainers
Readme
WA MediaBox
Modern lightbox without jQuery and with iframe support.
GALLERIES / PAGINATION / IFRAME / YOUTUBE VIDEOS / RESPONSIVE / MODERN DESIGN
NO jQuery needed
Installation
You can install the WA MediaBox manually by copying the files or you can use NPM:
npm install wa-mediabox
Note that the library does NOT export any module so you can use it standalone or pack it with your favourite tool such as Webpack but the WA MediaBox will be available only as a global variable as the JavaScript API
section describes below.
Usage
Load the WA MediaBox JavaScript and CSS:
<script type="text/javascript" src="node_modules/wa-mediabox/dist/wa-mediabox.min.js"></script>
<link rel="stylesheet" type="text/css" href="node_modules/wa-mediabox/dist/wa-mediabox.min.css">
When page loads then the following elements are bound to the WA MediaBox automatically:
For Images
<a href="image.jpg" data-mediabox="my-gallery-name" data-title="Sample image">
<img src="image-thumb.jpg" alt="Image" />
</a>
For Iframes
<a href="https://www.youtube.com/embed/FA_8TY9Z5Zg?rel=0"
data-mediabox="my-gallery-name"
data-iframe="true"
data-width="853"
data-height="480"
data-title="Sample video in iframe">
<img src="image-thumb.jpg" alt="Image" />
</a>
YouTube videos are detected automatically so you can omit the data-iframe attribute.
JavaScript API
<script type="text/javascript">
// Bind single element manually
WAMediaBox.bind(document.querySelector(".my-element"));
// Bind all child elements
WAMediaBox.bindAll(document.querySelector(".my-parent-element"));
// Translate - set before any binding
WAMediaBox.lang = {
prev: "Previous",
next: "Next",
close: "Close",
openInNew: "Open in new window"
};
</script>
License
The MIT License (MIT)
Copyright (c) 2015 - 2019 Jiri Hybek [email protected] (jiri.hybek.cz)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.