Download The Plugin
* Note that you should be importing the core library before jFlow. Otherwise, you’ll get some obvious errors!
To use the jFlow plugin, you’ll need to understand the function of some ids and classes.
- div#controller: This element will serve as our “hook” when calling our jQuery.
- .jFlowControl: These spans will be children of the #controller div. For as many slides as you have, you must create associated span tags with this class. For example, if I had five slides, I must have five tags with a class of .jFlowControl. You’ll understand this more by example, shortly.
- div#slides: Within the slides div, you need to nest additional divs that contain your desired content for each “slide”. More on this later.
- .jFlowPrev, .jFlowNext: These two classes allow you to continue to the next slide, or vice versa.
Sample HTML Document
Here is a featured image. Nice!
Here is another neat featured image. Nice!
Here is one last very cool featured image. Nice!
Let’s go over this a bit.
- As with most pages, we’ve wrapped our entire contents in a “wrap” element. This is purely for aesthetic reasons. It’s not required.
- In my controller div (which is the hook for jFlow), I’ve added three span tags with a class of “jFlowControl”. Think of these spans as tabs. If you click “No 3″, it will quickly cycle to the third associated “slide”. Remember, the number of span tags that you have must be equal to the number of divs within your “slide” div. Note that both have three.
- Moving along, we now come to a div with an id of “prevNext”. This isn’t a key id, I could have named it Rick if I had wanted. It’s simply a wrapper div so that I can control where my “Next” and “Previous” buttons go on the page. The class name of the images are important however: ‘jFlowPrev’, ‘jFlowNext’.
- Last, we come to the “slides” div. Within this div, we’ll place children divs. Each of these children will serve to be one “tab”. Once again, note that if I wanted to add a fourth image, I would also need to an additional “jFlowControl” span tag within the controller div.
The code that we have to write is quite simple. First, review the final script, and then I’ll go over each line.
That’s it!. First, we’re waiting for when the document is ready to be traversed. Then, we grab our controller div and call the “jFlow” method. There are many parameters available to us, but we’ll just use a few.
- Slides: It’s asking, “What is the name of the div element that contains each slide – or tab? We’ll associate it with the appropriate “slides” div that I created earlier. But, you can change it if you like.
- Width, Height: These are required. In this example, I’m only using images. As a result, I’ve set the width and height values equal to those of the images.
- Duration: In milliseconds, how long do you want the transition from slide to slide take? I’ve set 600 – which is about one half of a second.
The only other thing that you’ll want to implement is some CSS styling. However, jFlow will work perfectly without it. That would obviously only be for aesthetic reasons.