jQuery File Download v1.1.0 Released

The Basics

Updated:

• Original post
• jquery.fileDownload.js source
• Demo of jQuery File Download in action using MVC 3
• Changelog

Whats new?

In order to make jQuery File Download a little bit easier to use for a rich user experience (jQuery UI required) I have added some additional “options” arguments. These options arguments create a jQuery UI dialog using the specified HTML for different download lifecycle events.

• preparingMessageHtml – this HTML is displayed in a jQuery UI dialog immediately after the user clicks a jQuery File Download enabled link. If the file download is a success or failure the dialog is automatically hidden.
• failMessageHtml – this HTML is displayed in a jQuery UI dialog if a failure occurs in the file download.
• dialogOptions – the “options” argument that gets passed into jQuery UI dialog. Lets you get all custom with your dialog set up if you’d like. Defaults to { modal : true }.

New Example Code

//the below uses jQuery "on" http://api.jquery.com/on/ (jQuery 1.7 + required, otherwise use "delegate" or "live") so that any
//<a class="fileDownload..."/> that is ever loaded into an Ajax site will automatically use jquery.fileDownload.js
//if you are using "on":
//you should generally be able to reduce the scope of the selector below "document" but it is used in this example so it
//works for possible dynamic manipulation in the entire DOM

$(function() {
    $(document).on("click", "a.fileDownloadSimpleRichExperience", function() {
        $.fileDownload($(this).attr('href'), {
            preparingMessageHtml: "We are preparing your report, please wait...",
            failMessageHtml: "There was a problem generating your report, please try again."
        });
        return false; //this is critical to stop the click event which will trigger a normal file download!
    });
});

Head on over to the demo to see it in action (top example)

More robust demo page

I have also added source toggling to the demo page so that it is very easy to see the corresponding source code to a given example.

Enjoy!

As always let me know if you can think of any cool features to add or have any questions/problems.