frontend tools for working with images
Switch branches/tags
Nothing to show
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.
images
.gitignore
README.md
cooperhewitt.images.css
index.html
jquery.imageDisplayer.js
jquery.imageGrid.js

README.md

js-cooperhewitt-images

Image layout functionality as used on the Cooper Hewitt Online Collections. Check out the live demo.

Thumbnail Grids: jquery.imageGrid.js

jquery.imageGrid.js creates a grid of square thumbnails with rollover functionality. It assumes your markup is structured like this:

<ul id="myImageGrid" class="thumbnails">
  <li class="thumbnail">
    <a href="#">
      <img class="out" src="/path/to/image.jpg" data-allow-redraw />
    </a>
  </li>
</ul>

and is invoked by calling imageGrid() on the jQuery element like so: $('#myImageGrid').imageGrid()

Rollover

It also assumes your images are named in a fashion where the rollover and rollout images for a single thumbnail share a common root with a stated size, for example image1_out.jpg and image1_over.jpg. You can configure these extensions and other parameters by using data attribues on the outer wrapper. Specifically:

  • data-mouseout-image-size The unique part of the mouseout image's filename. In image1_out.jpg, this is the string out. The default is out.
  • data-mouseover-image-size The unique part of the mouseover image's filename. In image1_over.jpg, this is the string over. The default is over
  • data-mouseout-class-name A class that will be applied to the mouseout image. Defaults to out.
  • data-mouseover-class-name A class that will be applied to the mouseout image. Defaults to over.

Image Alignment

While the thumbnails are always square, they are capable of displaying non-square images. A class name of portrait or landscape will be applied accordingly. In the case of landscape images, a top CSS attribute will be calculated so as to vertically center the images. portrait images are centered in the CSS file.

Other notes:

  • Removing data-allow-redraw from within a li.thumbnail will disable the rollover code for an individual thumbnail.
  • The a href doesn't have to be # - make it whatever URL you want.
  • This code will work from within $(document).ready() but I've been using it from $(window).load() so that the rollovers don't invoke on half-loaded images. Probably the right way to do this would be to handle loading in JS for every thumbnail (pull requests accepted!) and stagger the binding of events.

Image Preloading and Resizing: jquery.imageDisplayer.js

jquery.imageDisplayer.js allows users with JS enabled to see a low-res image while they are waiting for the full one to load. On load, it allows them to toggle between a collapsed and expanded state. It also can adjust the height of the collapsed image to match the window height. It assumes your markup is structured like this:

<div id="myImageDisplayer" class="picture-holder" data-image-full-src="images/cat_full.jpg" data-image-loading-src="images/cat_load.gif">
  <a href="images/cat_full.jpg">
    <img src="images/cat_full.jpg" data-allow-redraw />
  </a>
</div>

You can configure some parameters using the data attributes on .picture-holder:

  • data-image-loading-src: The source of the image to use while the big one is loading.

You can invoke it with $('#myImageDisplayer').imageDisplayer(). The imageDisplayer accepts an options object:

{
	clickToScale: allow toggling between full/small sized images on click. defaults to true
	fitToFold: scale the small image to always match the window's innerHeight. defaults to false 
}

Expanding / Collapsing

The code will toggle two class names, expanded and collapsed, on clicking the image. Style them accordingly.

Other notes:

  • The source of the full-sized image should be the one set as the src of the <img> element. This way, the page won't look broken for non-JS users.
  • You should invoke this code from within $(document).ready() so that the code can add in the loading image before it loads the fullsized one.