Skip to content

bgcom/gallery-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gallery Viewer

A slideshow with zoom that is flexible to whatever data you want to put in.

Getting Started

Download the production version or the development version.

In your web page:

<script src="jquery.js"></script>
<script src="jquery-ui.js"></script>
<script src="handlebars.js"></script>
<script src="history.js"></script>
<script src="dist/gallery-viewer.min.js"></script>
<script>
jQuery(function($) {
  $("#gallery-viewer").galleryViewer({
    // content of the template
    template: $("#galleryViewer-template").html(),
    // handler when the image is displayed
    imageDisplayed: function (e, ui) {
        console.log("I changed element");
    }
});
</script>
<ul class="galleryViewer-ThumbnailList">
    <li class="galleryViewer-ThumbnailContainer">
        <a href="" class="galleryViewer-ThumbnailLink" key="element1" 
           data='{"text": "foo"}'>
           See element1
        </a>
    </li>
    <li class="galleryViewer-ThumbnailContainer">
        <a href="" class="galleryViewer-ThumbnailLink" key="element2" 
           data='{"text": "bar"}'>
           See element2
        </a>
    </li>
</ul>
<div id="gallery-viewer"></div>
<script id="galleryViewer-template" type="text/template">
        <div class="galleryViewer-main box">
            <div class="galleryViewer-main-container">
                <div class="galleryViewer-photo-container">
                    <p> {{elem.text}} </p>
                    <button type="button" class="galleryViewer-previous"></button>
                    <button type="button" class="galleryViewer-next"></button>
                    <div class="galleryViewer-zoom-container">
                        <button type="button" class="galleryViewer-zoomOut"></button>
                        <button type="button" class="galleryViewer-zoomIn"></button>
                    </div>
                </div>
                <div class="galleryViewer-side-container box grey">
                    <button type="button" class="galleryViewer-close"></button>
                    <div class="content">
                         Element number: {{elem.index}} / {{totalElements}})
                    </div>
                </div>
            </div>
        </div>
</script>  

Documentation

(Coming soon)

Examples

(Coming soon)

Release History

(Nothing yet)

License

Copyright (c) 2012 BGcom
Licensed under the MIT license.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Important notes

Please don't edit files in the dist subdirectory as they are generated via grunt. You'll find source code in the src subdirectory!

While grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the test/*.html unit test file(s) in actual browsers.

Installing grunt

This assumes you have node.js and npm installed already.

  1. Test that grunt is installed globally by running grunt --version at the command-line.
  2. If grunt isn't installed globally, run npm install -g grunt to install the latest version. You may need to run sudo npm install -g grunt.
  3. From the root directory of this project, run npm install to install the project's dependencies.

Installing PhantomJS

In order for the qunit task to work properly, PhantomJS must be installed and in the system PATH (if you can run "phantomjs" at the command line, this task should work).

Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS.

Note that the phantomjs executable needs to be in the system PATH for grunt to see it.

About

A JQuery UI plugin for image gallery displaying

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published