diff --git a/README.md b/README.md new file mode 100644 index 0000000..372450d --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +GalleryView - jQuery Photo Gallery Plugin +Author: Jack Anderson + +INSTRUCTIONS FOR USE +--------------------------------- +1. Place galleryview-x.x folder somewhere in your website directory structure (you can rename this folder if desired) + +2. Include script tags for the desired version of the script (uncompressed, packed) and for the included jQuery Timers and Easing plugin files + +3. Include a reference to the jquery.galleryview-x.x.css stylesheet in your document + +4. Create an unordered list in your HTML with the content you wish to be displayed in your gallery (see below for more information on markup options + +5. Add class "galleryView" to the unordered list to make it invisible at firt (in order to prevent a flash of unstyled content). + +6. Call the GalleryView plugin with the function call below: + + ```js + $('#id_of_list').galleryView() + ``` + + To override default option values, include them in object literal format in the call to the plugin, like so: + + ```js + $('#id_of_list').galleryView({ + panel_width: 800, + panel_height: 600, + frame_width: 120, + frame_height: 90 + }); + ``` + + Refer to the uncompressed javascript to see a full list of options, their effects on the plugin and their default values. + + + +HTML MARKUP REQUIREMENTS +--------------------------------- +Below, I will show you the markup required to produce various types of galleries. After the first example, +I will exclude the UL wrapper and only show the HTML necessary for a single panel and/or frame. + +1. Basic slideshow (no added features) + + ```html + + ``` + + This is the simplest gallery one can have. By default, the filmstrip will appear below the panels. The number of frames visible will be determined by the size of the panels. If there is enough space in the gallery to fit all the filmstrip frames, the filmstrip will be centered within the gallery. If there are too many frames, the additional frames will be hidden from view initially, appearing as the filmstrip slides to the left with each transition. Panel and frame dimensions are set via plugin options, as is the location of the filmstrip. It can be set to appear below, above, or to either side of the panels. + +2. Slideshow with custom thumbnails + ```html +
  • + image +
    • + ``` + + By adding a data-frame attribute with a relative or absolute path to a separate image, GalleryView will use it to populate the thumbnail. This can be helpful when using large panel images and small thumbnails to avoid degradation due to scaling. + +3. Slideshow with panel overlays + ```html +
  • + image +
    • + ``` + + For this gallery, the contents of the title and data-description attributes will display on top of the panel image, its position determined by the 'overlay_position' option. The color of the overlays are set in the included CSS file. + +4. Slideshow with images delayed loading + ```html +
  • image1
    • +
  • image2
    • +
  • image3
    • +
  • image4
    • + ``` + + Put placeholder image into src attribute and store real image url in data-original attribute. The browser won't load the real images until the GalleryView is initialized (that is, when $('#id_of_list').galleryView() is called). This feature is inspired by the [Lazy Load Plugin for jQuery](https://github.com/tuupola/jquery_lazyload) by [Mika Tuupola](http://www.appelsiini.net/projects/lazyload). + +CREATING/USING CUSTOM NAVIGATION THEMES +--------------------------------- +GalleryView comes with two themes by default: +- dark +- light + +The dark themes contain dark navigation buttons and are best used in galleries with light backgrounds. The light themes contain light colored images and are best for galleries with dark backgrounds. Both themes also contain oversized panel navigation buttons to demonstrate GalleryView's ability to use any kind of navigation images you may want to use. + +To create your own navigation theme, first create the following images: +- next.png +- prev.png +- play.png +- pause.png +- panel-nav-next.png +- panel-nav-prev.png + +The images can be of any file type. Then, update the galleryView CSS file with the paths to your new navigation images. + + +That should hopefully be enough to get you started on the right track. Feel free to experiment and find me on twitter (@jackwanders) if you have any questions or comments. Enjoy! \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index 78a0938..0000000 --- a/README.txt +++ /dev/null @@ -1,87 +0,0 @@ -GalleryView - jQuery Photo Gallery Plugin -Author: Jack Anderson - -INSTRUCTIONS FOR USE ---------------------------------- -1) Place galleryview-x.x folder somewhere in your website directory structure (you can rename this folder if desired) -2) Include script tags for the desired version of the script (uncompressed, packed) and for the included jQuery Timers and Easing plugin files -3) Include a reference to the jquery.galleryview-x.x.css stylesheet in your document -4) Create an unordered list in your HTML with the content you wish to be displayed in your gallery (see below for more information on markup options -5) Edit the id of the first rule in jquery.galleryview-3.0.css to match the id given to your unordered list -6) Call the GalleryView plugin with the function call below: - - $('#id_of_list').galleryView() - - To override default option values, include them in object literal format in the call to the plugin, like so: - - $('#id_of_list').galleryView({ - panel_width: 800, - panel_height: 600, - frame_width: 120, - frame_height: 90 - }); - - Refer to the uncompressed javascript to see a full list of options, their effects on the plugin and their default values. - - - -HTML MARKUP REQUIREMENTS ---------------------------------- -Below, I will show you the markup required to produce various types of galleries. After the first example, -I will exclude the UL wrapper and only show the HTML necessary for a single panel and/or frame. - -1) Basic slideshow (no added features) - - - This is the simplest gallery one can have. By default, the filmstrip will appear below the panels. The number of frames visible will be - determined by the size of the panels. If there is enough space in the gallery to fit all the filmstrip frames, the filmstrip will be centered - within the gallery. If there are too many frames, the additional frames will be hidden from view initially, appearing as the filmstrip slides - to the left with each transition. Panel and frame dimensions are set via plugin options, as is the location of the filmstrip. It can be set - to appear below, above, or to either side of the panels. - -2) Slideshow with custom thumbnails - -
  • - image -
    • - - By adding a data-frame attribute with a relative or absolute path to a separate image, GalleryView will use it to populate the thumbnail. This - can be helpful when using large panel images and small thumbnails to avoid degradation due to scaling. - -3) Slideshow with panel overlays - -
  • - image -
    • - - For this gallery, the contents of the title and data-description attributes will display on top of the panel image, its position determined by the - 'overlay_position' option. The color of the overlays are set in the included CSS file. - -CREATING/USING CUSTOM NAVIGATION THEMES ---------------------------------- -GalleryView comes with two themes by default: - - dark - - light - -The dark themes contain dark navigation buttons and are best used in galleries with light backgrounds. The light themes contain light -colored images and are best for galleries with dark backgrounds. Both themes also contain oversized panel navigation buttons to demonstrate -GalleryView's ability to use any kind of navigation images you may want to use - -To create your own navigation theme, first create the following images: - - next.png - - prev.png - - play.png - - pause.png - - panel-nav-next.png - - panel-nav-prev.png - -The images can be of any file type. Then, update the galleryView CSS file with the paths to your new navigation images. - - -That should hopefully be enough to get you started on the right track. Feel free to experiment and find me on twitter (@jackwanders) -if you have any questions or comments. Enjoy! \ No newline at end of file diff --git a/css/grey.gif b/css/grey.gif new file mode 100644 index 0000000..8d74456 Binary files /dev/null and b/css/grey.gif differ diff --git a/css/jquery.galleryview-3.0-dev.css b/css/jquery.galleryview-3.0-dev.css index 42d7ee9..47708d4 100644 --- a/css/jquery.galleryview-3.0-dev.css +++ b/css/jquery.galleryview-3.0-dev.css @@ -8,8 +8,7 @@ */ /* GALLERY LIST */ -/* IMPORTANT - Change '#myGallery' to the ID of your gallery list to prevent a flash of unstyled content */ -#myGallery { display: none; } +.galleryView { display: none; } .gv_galleryWrap { position: relative; background: #222; font-size: 10pt; } diff --git a/demos/all-features.html b/demos/all-features.html index 31dc4a0..4599879 100644 --- a/demos/all-features.html +++ b/demos/all-features.html @@ -52,6 +52,17 @@ show_infobar: true, //BOOLEAN - flag to show or hide infobar infobar_opacity: 1 //FLOAT - transparency for info bar }); + + var isDelayedGalleryInitialized = false; + $('#btn').click(function(){ + if(!isDelayedGalleryInitialized){ + $('.gv_galleryWrap').hide(); + $('#delayedGallery').galleryView(); + isDelayedGalleryInitialized = true; + }else{ + $('.gv_galleryWrap').toggle(); + } + }); }); @@ -64,7 +75,7 @@ - + +

    Please view the source of this page if you are having difficulties setting up GalleryView.

    diff --git a/demos/default.html b/demos/default.html index 8cbf10e..c451cf8 100644 --- a/demos/default.html +++ b/demos/default.html @@ -25,7 +25,7 @@ -