Flashybox
A small (less than 3 KB gzipped!) jQuery (2.x) plugin to show fixed size image collage with fading images. You just provide list of images in a markup and call flashybox()
on it and it'll covert images into flashybox wall.
Example
Click here to view demo GIF.
Usage
Download the tarball and extract it, include jquery.flashy.js
after including jquery
using script
tag in your page <head>
.
My Flashy Page ... ...
For the sake of convenience, Flashybox is also made available as an NPM module (since it supports CommonJS-style loading). Install it using npm
npm install flashybox --save
Use
Basic Usage
- Initialize:
You'll need all your images in the markup either directly within a
div
or in aul
as follows (any parent element will do as long as you use<img>
for images). Be sure that you haveflashybox-container
class specified in your parent.
This is just a temporary markup and flashy will replace it using built-in template.
- Call:
Flashybox provides a method
flashybox()
which optionally acceptsconfig
map to provide certain options.
<script type="text/javascript"> ;</script>
Known Issues
- For Consistency in box size, Flashybox forces image resize in blocks, obviously it requires some CSS wizardry to keep image aspect-ratio intact along with consistent box size, but my intention is to keep the plugin simple to understand and hack. However, pull-requests are welcome.
Version Information
- 0.1.0 - First Release.