home about publications talks teaching photos tools archives
about writing tools archives
about writing

From Flickr to Photoswipe: A Brief Tutorial

I recently revamped my photos page. I wanted an interactive, cross-device gallery to display the photos. In the past, I had been using jbgallery, a slick tool that used jQuery. I was having a bit of a hard time getting it to work the way I wanted and it was a little laggy on iOS and Android devices, so I decided to part ways with it. I don't want to speak poorly of it -- it works very well and the developer is friendly, happy to chat, and works to improve his library constantly. It's a nice tool, but wasn't what I was looking for in the end.

Photoswipe looked rad and performed pretty well on my iOS devices (an iPhone 4 and a 2012 iPad with Retina Display). I decided to give it a whirl.

I had some priorities. I wanted it to connect it with a specific flickr set using JSON; I was hoping to have the javascript recognize whether or not someone was on a retina display and choose which flickr image to pull accordingly; and I wanted it to adapt nicely across screen sizes and devices. Here's how it works, for those interested.

First, and Foremost: I stand on the shoulders of others -- Brian Cray, for an insightful post on detecting retina displays with javascript, and Viget.com, for introducing me to using javascript to interact with flickr JSON feeds many moons ago. The function below is modeled on Viget's original tutorial. And, of course, huge thanks to Photoswipe, for their amazing, free set of scripts/css/html.

This is my first tutorial related to this kind of stuff - take it with a grain of salt. And let me know if there are blatant errors or better ways to do things.

Into the body of your webpage, you'll need to put the code pointing to the flickr call. Place this wisely -- it'll play an important role in making all of your photos appear in the proper place. As placement is a bit context specific, we won't go into details here. Play around with it or view the source on photographs if you have initial questions.

<script type="text/javascript" language="javascript" src="http://api.flickr.com/services/rest/?method=flickr.photosets.getPhotos&api_key=[YOUR APRI KEY]&photoset_id=[YOUR PHOTOSET ID]&format=json&extras=original_format"></script>

Just doing that isn't enough -- remember, we requested the returned information in JSON, which we need to handle. Thankfully, javascript can make short work of that JSON for you.

Open your favorite text editor and create a new file. Paste the following into it. Create a reference to it in your photo gallery page. We'll go through it in more detail below.

function jsonFlickrApi(rsp) {

//detect retina
var retina = window.devicePixelRatio > 1 ? true : false;

//makes sure everything's ok
if (rsp.stat != "ok"){
//count number of responses
var num = rsp.photoset.photo.length;
//variables "r" + "s" contain 
//markup generated by below loop
//r=retina, s=standard
var r = "";
var s = "";

//this loop runs through every item and creates HTML that will display nicely on your page
for (var i=0; i < num; i++) {
photo = rsp.photoset.photo[i];

//create url for retina (o=original, bt=big thumb) and standard (st=standard thumb,
//so= flickr "large")
o_url = "http://farm"+ photo.farm +".staticflickr.com/"+ photo.server +"/"+ 
photo.id +"_"+ photo.originalsecret +"_o.jpg";
bt_url = "http://farm"+ photo.farm +".static.flickr.com/"+ photo.server +"/"+ 
photo.id +"_"+ photo.secret +"_q.jpg";
st_url = "http://farm"+ photo.farm +".static.flickr.com/"+ photo.server +"/"+ 
photo.id +"_"+ photo.secret +"_s.jpg";
so_url = "http://farm"+ photo.farm +".static.flickr.com/"+ photo.server +"/"+ 
photo.id +"_"+ photo.secret +"_b.jpg";
r += "<li><a href='"+ o_url +"'><img alt='"+ photo.title +"' src='"+ bt_url 
  	+"' title='Click to view "+ photo.title +" full size'/></a></li>";
s += "<li><a href='"+ so_url +"'><img alt='"+ photo.title +"' src='"+ st_url 
  	+"' title='Click to view "+ photo.title +" full size'/></a></li>";

//should be self explanatory
if (retina){
q = '<div id="MainContent"><ul id="Gallery" class="gallery">'+ r +' </ul></div>'
q = '<div id="MainContent"><ul id="Gallery" class="gallery">'+ s +' </ul></div>'

//this tells the JavaScript to write everything in variable q onto the page

Our first line defines our function. Ce n'est rien.

Our next couple of lines set a newly defined variable -- retina -- to see if the Pixel Ratio > 1.

Our next four lines check that we're getting an okay JSON response from flickr. If it's not okay, things are going to halt. This could be due to a poorly formed request, a lack of API key, etc.

Next, we're going to get the number of responses (photos) pulled from our response. This will be important later. We're also going to define a couple of empty variables that we'll use later.

Now comes a bit of a headache. The comment explains how we're choosing a number of different photo sizes and building URLs to access them. Flickr recently revised its API, so for more information / to keep this thing up to date check out the official documentation.

We basically choose a large square image for the thumbnail for retina displays and a smaller one for non-retina displays; similarly, we choose a large image for retina displays and a smaller one for non-retina displays. This introduces a bit of an issue -- if a user is on Edge with a retina display, the image will load slooooowly. There are ways around this, but its a bit too much for me to deal with.

The next bits -- r+= and s+= -- build list items for each image. This chunk should be filled with code relevant to the layout of your page. If you're not using PhotoSwipe, you can adapt this to whatever you need it to be. Just be sure to keep track of the quotation marks.

If we have a retina display, we embed the retina images; otherwise, we embed the standard images.

And we're off! I made a number of other small tweaks to the PhotoSwipe JS to make it work the way I wanted. But, overall, this covers the gist of it. Download a copy of the script here.