Skip to content
Simple JavaScript based in browser gallery.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src
README.md

README.md

edvard

A simple and stupid image gallery. Given some JSON data (that edvard loads via AJAX), edvard injects a gallery into the DOM.

Usage

Define the photos that you want to have in the gallery in a file as JSON data. This JSON data defines an object with the properties photos. The value of photos is an array of the gallery photos. Each element is an object with the following propertes:

  • url (required): The URL of the fullscreen image.
  • thumbnail_url (optional): The URL of the thumbnail image.
  • medium_url (optional): The URL of the medium sized image. This is used for the inline view.
  • subtitle (optional): A descriptive text to show for the photo.

Example:


    {
        "photos": [
            {
                "url": "img001.png",
                "subtitle": "Awesome stuff"
            }
        ]
    }

Call edvard.init() to inject the gallery.

    <script type="text/javascript">
      $(function() { edvard.init(); });
    </script>

This will render an overview (using the thumbnails) into an element with the CSS overview, the current image into .photo_view .photo and the subtitle into .photo_view .subtitle.

It will add event handlers to .navigation .nav_previous and .navigation .nav_next.

Options

You can call edvard.init() with an optional options parameter (edvard.init(options)). This is an object which can have the following properties:

  • navigation: The navigation node (default: '.navigation').
  • overview: The overview node (default: '.overview').
  • photoDisplay: The photo display node (default: '.photo_view .photo').
  • photosSource: The URI of the photo JSON data (default: './photos.json').
  • photoSubtitle: The photo subtitle node (default: '.photo_view .subtitle').
  • thumbnailUrl: A function to turn the full screen photo URL into a thumbnail URL (default: a function that prepends 'thumbnail_').
  • imageUrl: A function to turn the full screen photo URL into a medium image URL (default: a function that prepends 'medium_').

Example

For an example, see /example/index.html.

You can’t perform that action at this time.