Monday, May 10, 2010

Creating jQuery plug-ins for an unordered list

I've been writing a lot more JavaScript recently, sometime's following other peoples code and sometime's writing my own from scratch. A lot of this JavaScript has been done using jQuery. As most of our development team was new to JavaScript the code quickly became unstructured and messy. There had to be a better way.

I was really pleased to discover that it didn't have to be this way and jQuery had created a really easy to use plug-in architecture. As you'll see from this quick guide it's very easy to create a neat and elegant JavaScript solution using a jQuery plug-in. What I really like about the jQuery plug-in solution is that it makes it easy to provide "Progressive Enhancement" to your site. So that if JavaScript has been disabled, the mark-up will remain unchanged. It' like you are rewarding people with JavaScript and providing a richer browsing experience.

The following example is similar to a real world example I was recently asked to create. The client wanted an un-ordered list to only show the first 5 elements and then provide the user with a link to see the other element. They also wanted the list to be sorted. For this I decided to break the problem down into it's 2 parts.

Part 1 would be to create a "listsort" plug-in, Part 2 would be the "hideextra" plug-in to
show/hide the extra elements.

Here's what the final List ended up looking like:

...and these are the steps to create the above:




Part 1 - Creating the listsort Plug-in

  • First up we'll need an unordered list on a page to work with, for this example I've chosen fruit:

  • First up you need to create a new JavaScript file, it should be named as follows:
  • Name your file jquery.[insert name of plug-in].js, e.g.. jquery.listsort.js
  • The basis for all jquery plug-ins is the same you loop around the jQuery object using jQuery.each and when your finished you should return the jQuery object, so the next plug-in can work with the object. What this amounts to is the following
(function ($) {
$.fn.sortlist = function (options) {

return this.each(function () {

// Guts goes here

});

};

})(jQuery);
  • Now we have the basics, we can build on this to create our plug-in. We'll loop around the current unordered list element and sort by the elements text().
(function ($) {
$.fn.sortlist = function (options) {

return this.each(function (listIndex, listInstance) {

var listItems = $(listInstance).children('li');

listItems.sort(function (a, b) {
var compA = $(a).text();
var compB = $(b).text();
return (compA < compB) ? -1 : (compA > compB) ? 1 : 0;
});

$.each(listItems, function (listItemIndex, listItemInstance) { $(listInstance).append(listItemInstance); });

});

};

})(jQuery);
  • While the above will work, we can make use of jQuery's plug-in architecture by using the options parameters. This way if a user wants to change our sort function to say sort on the class name of the list item element they can do this by overriding.
(function ($) {
$.fn.sortlist = function (options) {

var defaults = {
sortElement: 'li',
sortFunction: function (a, b) {
var compA = $(a).text();
var compB = $(b).text();
return (compA < compB) ? -1 : (compA > compB) ? 1 : 0;
}
};

var options = $.extend(defaults, options);

return this.each(function (listIndex, listInstance) {

var listItems = $(listInstance).children(options.sortElement);

listItems.sort(options.sortFunction);

$.each(listItems, function (listItemIndex, listItemInstance) { $(listInstance).append(listItemInstance); });

});

};

})(jQuery);
  • To call this from another script would be very easy, all you'd have to do is:
$(document).ready(function () {
$("ul").sortlist();
});
  • As i mentioned before, if the user doesn't have JavaScript enabled, nothing will change and the unordered list will remain unsorted. However if they have it installed the list will go from this:
  • To this
  • Now if you want to change the order, you can override the sort function by using jquery options parameters and extend function:
$(document).ready(function () {

$("ul").sortlist(
{ 
sortFunction: function (a, b) {
var compA = $(a).text();
var compB = $(b).text();
return (compA > compB) ? -1 : (compA < compB) ? 1 : 0;
} 
});
});
  • Pretty cool huh?

Part 2 - Creating the hideextra Plug-in

  • You already know the basics for creating a jquery plug-in, so let's get on with the code for the hideextra plug-in.
(function ($) {

$.fn.hideextra = function (options) {

var defaults = {
extraElement: 'li',
extraClass: 'extra',
buttonClass: 'showMore',
maxItems: 4,
moreText: "more...",
lessText: "less..."
};

var options = $.extend(defaults, options);

return this.each(function (listIndex, listInstance) {

var listItems = $(listInstance).children(options.extraElement);

for (i = 0; i < listItems.length; i++) {

if (i > (options.maxItems - 1)) {
$(listItems[i]).hide();
$(listItems[i]).addClass(options.extraClass);
}
}

var hiddenLis = $(options.extraElement + '.' + options.extraClass, $(listInstance));

// Add More/Less Link
if (listItems.length > options.maxItems) {
$(listInstance).append('<li><a href="#_" class="' + options.buttonClass + '">' + hiddenLis.length + ' ' + options.moreText + '</a></li>');
}

// Add the click events
var moreLink = $('.' + options.buttonClass, $(listInstance));

moreLink.click(function () {

if (moreLink.text().indexOf(options.moreText) > 0) {
hiddenLis.show();
moreLink.text(options.lessText);
}
else {
hiddenLis.hide();
moreLink.text(hiddenLis.length + ' ' + options.moreText);
}
});

});

};

})(jQuery);
This will create a list like the following:

Putting it all together

Now I've got 2 plug-ins created I can chain them together to get a list that is sorted and hide's extra elements just like this:

Chaining jquery plug-ins together

$(document).ready(function () {

$("ul").sortlist().hideextra();

});

Working Example

Conclusion

I've created an ASP.NET MVC 2 version of this code, which can be found on my sky drive here. Or if you just want the jquery plug-ins they can be found here: jquery.hideextra.js jquery.sortlist.js
Please feel free to down load the example or Js files and check it out.

33 comments:

  1. I read your blog it's really good, thanks for sharing valuable information with us.
    Excellent Article, Nice to read your article, very informative.
    Excellent article Top AC mechanics Professional Camera sellers ChennaiCatering Service in ChennaiTop Educational Institute Chennai

    Excellent Article
    swimmingpool contractor chennai
    swimmingpool equipment dealer chennai
    swimmingpool consultant chennai

    ReplyDelete
  2. I strongly believe that there will be great opportunities for those who looked into this area, thanks much for creating and posting in here...
    Best Online Software Training Institute | Python Online Training

    ReplyDelete
  3. This was an nice and amazing and the given contents were very useful and the precision has given here is good.
    Data Science Training in Chennai

    ReplyDelete
  4. Thank you so much as you have been willing to sharing your information with us. And not only that we will spend a lot of time other blog but your blog is so informative and compare to that your blog is unique.see more: Python Online Training

    ReplyDelete
  5. The Post is a Wonderful Opportunity for Beginners of Java Course. Keep regular Updates of Blogging.
    python training in hyderabad

    ReplyDelete
  6. Awesome post.
    beautiful information.
    keep sharing the posts.
    check out :http://tinyurl.com/y42jshqh

    ReplyDelete
  7. Great blog !It is best institute.Top Training institute In chennai
    http://chennaitraining.in/openspan-training-in-chennai/
    http://chennaitraining.in/uipath-training-in-chennai/
    http://chennaitraining.in/automation-anywhere-training-in-chennai/
    http://chennaitraining.in/microsoft-azure-training-in-chennai/
    http://chennaitraining.in/workday-training-in-chennai/
    http://chennaitraining.in/vmware-training-in-chennai/

    ReplyDelete
  8. I feel really happy to have seen your web page and look forward to so many more entertaining times reading here. Thanks once more for all the details.
    Data Science Training in Hyderabad | Data Science Course in Hyderabad

    ReplyDelete
  9. You are in point of fact a just right webmaster. The website loading speed is amazing. It kind of feels that you're doing any distinctive trick. Moreover, The contents are masterpiece. you have done a fantastic activity on this subject!
    Business Analytics Training in Hyderabad
    Business Analytics Course in Hyderabad

    ReplyDelete
  10. Really nice and interesting post. I was looking for this kind of information and enjoyed reading this one. Keep posting. Thanks for sharing.
    data science training in guduvanchery

    ReplyDelete
  11. it’s really nice and meanful. it’s really cool blog. Linking is very useful thing.you have really helped lots of people who visit blog and provide them usefull information.
    Data Science Training in Hyderabad

    I am really happy to say it’s an interesting post to read . I learn new information from your article , you are doing a great job . Keep it up

    Devops Training in USA

    Hadoop Training in Hyderabad

    Python Training in Hyderabad

    ReplyDelete
  12. Big data has made quite an impact on the world and data science has recently risen to be one of the hottest topics. Now how are these two related? data science course syllabus

    ReplyDelete

  13. it’s really nice and meanful. it’s really cool blog. Linking is very useful thing.you have really helped lots of people who visit blog and provide them usefull information.
    Data Science Training in Hyderabad

    I am really happy to say it’s an interesting post to read . I learn new information from your article , you are doing a great job . Keep it up

    Devops Training in USA

    Hadoop Training in Hyderabad

    Python Training in Hyderabad

    ReplyDelete
  14. I am really happy to say it’s an interesting post to read . I learn new information from your article , you are doing a great job . Keep it up

    Devops Training in Hyderabad

    Hadoop Training in Hyderabad

    Python Training in Hyderabad

    Tableau Training in Hyderabad

    Selenium Training in Hyderabad

    ReplyDelete
  15. Cool stuff you have and you keep overhaul every one of us
    data scientist course delhi

    ReplyDelete
  16. I got to know very amazing and useful information from this blog. Thanks for posting this blog
    ELLA JAMES

    ReplyDelete
  17. This comment has been removed by the author.

    ReplyDelete
  18. This comment has been removed by the author.

    ReplyDelete
  19. Nice and very informative blog, glad to learn something through you.
    data analytics course delhi

    ReplyDelete
  20. it’s really nice and meanful. it’s really cool blog. Linking is very useful thing.you have really helped lots of people who visit blog and provide them usefull information.
    Data Science Training in Hyderabad

    I am really happy to say it’s an interesting post to read . I learn new information from your article , you are doing a great job . Keep it up

    Devops Training in Hyderabad

    Hadoop Training in Hyderabad

    Python Training in Hyderabad

    Tableau Training in Hyderabad

    Selenium Training in Hyderabad

    ReplyDelete
  21. So happy to find good place to many here in nice post, the writing is just great, thanks for the post.

    ReplyDelete
  22. This is my first time visit here. From the tons of comments on your articles.I guess I am not only one having all the enjoyment right here!

    AWS Training in Hyderabad

    ReplyDelete
  23. Really Nice Information It's Very Helpful All courses Checkout Here.
    data scientist courses aurangabad

    ReplyDelete