The Lumebox is an Open-Source (GPL) Lightbox clone written as a JavaScript jQuery plugin (weighing in at around 11kB minified) with a few added features. One of the main features is that it adapts according to device type with mobile optimizations, another is that it can parse RSS feeds just as easily as displaying images. The plugin searches th…
JavaScript CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
js
style
index.html
license.txt
readme.txt

readme.txt

=== Lumebox ===
Plugin Homepage: http://anders.zakrisson.se/projects/lumebox
Author: Anders Zakrisson
Author website: http://anders.zakrisson.se
Author contact: contact-anders@zakrisson.se

The Lumebox is an Open-Source (GPL) Lightbox clone written as a JavaScript jQuery
plugin with a few added features. One of the main features is that it can parse
RSS feeds just as easily as displaying images. The plugin searches the post or
page for all links leading to images and opens them in a popup instead of
following them.

There are a couple of major new features in version 2.0, the first is
that it uses the Google Ajax Feed API to pull RSS-feeds (no need for local
proxies for feeds on other domains), the second is that it can detect when it's
displayed on mobile devices and then adapts the display to that. The last major
new feature is that the next image in queue to be displayed is now preloaded.

== Prerequisites ==

The Lumebox was written using jQuery 1.4.3 so I recommend that it is used in
combination with this or a later version but it might very well work with
previous versions as well, I just haven't tested it. To use show external RSS-
feeds a Google API key is needed.

== Installation ==

1. Load the lumebox.css or copy the classes to another file that'll be loaded
2. Load the Lumebox Javascript file somewhere on the page after jQuery has been
   loaded
3. Copy the image files in style/ somewhere and change the lumebox options-object
   if that directory is somewhere else than "style/"
4. Optional, get a Google API key from http://code.google.com/apis/ajaxfeeds/signup.html

== Usage ==

The plugin will automatically load and traverse the page if the file is loaded. It uses
a set of sensible defaults for its options, to change these just initialize a variable
called lumeboxOptions containing a map of the options and their values.

Add rel="lightbox" to any links that you want to be parsed by the Lumebox and
the title with the caption. It'll find the target of the link and use it for
source to the image in the popup and the content of the title attribute as
caption. Images and feeds can be grouped by naming them
rel="lightbox[groupName]". To avoid potential confusion between images and
feeds all RSS-feeds have to be grouped in a name starting with "rss", for
example rel="lightbox[rssGroup1]". To fetch external RSS-feeds a Google Ajax
API key must be provided when initializing the Lumebox (see below).

A sample is included which shows the most usual usages in action.

== Options ==

Options are passed as an object when initializing the Lumebox. All have default
values to the only ones that has to be specified are the ones which need to
change, defaults are shown in the parentheses.

* showAsList (false): If true all items in a group will be shown in a list in
  the Lumebox. Previous and Next click overlays are not created if this option
  is true.
* rss (empty array): An array of urls to RSS-feeds.
* duration ("normal"): Keyword (slow, normal, fast) or duration in milliseconds
  used for animating transitions.
* rssWidth (680): The width of the popup used for RSS-posts.
* opacity (0.7): The opacity of the overlay.
* loop (true): Whether to start over at item number one after pressing next at
  the last item.
* scrollToTop (false): Force scroll to the top of the popup everytime it's
  opened.
* autoNext (false): Loads the next item after autoNext milliseconds if the
  Lumebox is open.
* parentElementId (false): The id of an element to use as a parent for the
  popup, it will be inserted just before this element is closed. If no element
  id is passed the Lumebox is inserted right before the closing body-tag.
* useParentOffset (true): Use the offset of the parent element to position the
  popup.
* graphicsDir ("style/"): Relative path to the directory where the icons are
  stored.
* feedApiKey (false): If provided, this key is used to load the Google Ajax Feed
  API (http://code.google.com/apis/ajaxfeeds/) which is used to fetch external
  RSS-feeds.
* platformMode ("auto"): Whether to use gestures ("mobile"), clicks ("normal")
  or choose automatically depending on the platform ("auto").
* noCaptionClass ("tn"): If the link has this class the title-attribute won't be
  used as a caption.

== Changelog ==
= 2.1 =
* Added new option to disable the caption added through the title-attribute.
* The mobile lightbox now completely hides everything else in the DOM to provide
  a more consistent gallery-like experience, also changed the look in desktop mode.

= 2.0 =
* Added support for pulling RSS-feeds using Google Ajax Feed API and for using
  gestures on mobile platforms. The next image in line is also preloaded and
  images are now scaled to fit the screen if they are too big. There's a lot of
  small changes as well.
* Removed some options (proxy and fullscreen) and added some other (feedApiKey
  and platformMode) and changed the name for popupMaxWidth (now rssWidth).

= 1.06 =
* Removed the leading ">" that wordpress inserts in CDATA encoded rss-feeds due
  to placing it in a tag.

= 1.05 =
* Single images are now fetched and then shown using a callback to fix the
  positioning bug (top left corner is centered due to width of the popup is
  calculated to zero when it's shown before the image has been loaded)

= 1.04 =
* General stability enhancements
* Updated the styling of the lumebox, using some CSS3
* Updated the sample
* Added click areas for previous and next navigation
* The close button was added (again...)
* Removed info and help
* Don't have any good plan on how to display index information, so that's been
  removed for now
* Changed some default values for the options

= 1.03 =
* Fixed the sample in the release

= 1.02 =
* The close button was removed. Everyone clicks outside, right?
* Better resizing, the size and position are now animated simultaneously
* Fixed the bug that resized the popup with the content visible when using the
  next() or previous() functions
* Added basic gesture control, click and drag left to go to previous, click and
  go right to load the next post

= 1.01 =
* Clicks on links are now intercepted instead of changed to onCLicks
* The popup uses the browser scroll bar instead of adding a new one
* Some browser compatibility issues concerning size and position of
  the popup were fixed


= 1.0 =
* The first official release of Lumebox

== Known Issues ==

* Due to Firefox not returning any values (other than 0) when using
  jQuery.offset() the popup isn't correctly centered when the parent element is
  positioned (usually the body)
* Google Chrome doesn’t seem to parse XML-tags containing CSS-selectors
  correctly which means that even if <content:encoded> is present it’ll use the
  shorter <description> when parsing RSS-feeds

== License ==

Lumebox Wordpress Plugin - The jQuery Lumebox plugin for Wordpress.org
Copyright (C) 2010 Anders Zakrisson, Sogeti

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.