jquery

After we have finished the Flickr MVC app last time. This time will be sequel, ajaxified it.

Although the ASP.NET MVC do provide the abstract ajax helper class, only implementation exists publicly is Nikhil's. Certainly, ASP.NET Team will include the ASP.NET AJAX/Microsoft AJAX Library helper in the MVC framework for next CTP bits. As for this tutorial, I will continue with jquery instead of Microsoft AJAX Library because I'm more familiar with it.

The ajaxified instructions is mainly related to the view. In order to use jquery, put the library in ~/Content and add the reference to it in the layout.

<head runat="server">
    <title>My Sample MVC Application</title>
    <link href="../../Content/Site.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="../../Content/jquery.js"></script>
</head>

Next, Open the ~/Views/Home/Index.aspx. Then, add a placeholder div called "result" in the view. We'll use this div to display the response from the ajax call. Additionally, add a eye-candy loading indicator to let user knows that the page is being loaded.

<%Html.Form("Search", "Home", FormExtensions.FormMethod.post, new { ID = "theform" });%>
    <label for="tags">
        Tags:
    </label>
    <%=Html.TextBox("tags", 30) %>
    <%=Html.SubmitButton("find", "Find", "") %>
    <img src="../../Content/loading.gif" id="spinner" style="display:none;" />
    </form>
<div id="result"></div>

Last but not least, add some lines of script to make an ajax call once the form is goin to be submitted.

 $(document).ready(function() {        
        $('#theform').submit(function (){            
            $.post('/Home/Search', {'tags':$('#tags')[0].value}, completeRequest);
            $('#spinner').show();                        
            $('#result').slideUp(1500);
            return false;            
        });
    });
    
    function completeRequest(r){            
        $('#result').html(r).slideDown(1500);                            
        $('#spinner').hide();        
    }

The script will be invoked when the DOM is ready. It'll hook the form submit event, post the textbox value to ~/Home/Search, make the loading indicator visible, hide the result div and then, cancel the event to prevent the full post process. And then, after the request is completed, completeRequest function will be called. It will replace the div's content with the result from the response and then reveal the div by using slide down effect. And lastly, hide the indicator.

Try the page and Voila! The ajaxified is completed.

Compare to the traditional web form, MVC has a better degree to integrate with the javascript library. Though I use the web form view engine, extension method on the HTML Helper that makes the markup more flexible, no generated id. However, integration with the jquery may not be the easiest one for ASP.NET MVC as ASP.NET Team will deliver its own Ajax helper.

In conclusion, AJAX in ASP.NET MVC has a lot of room for improvement, either officially or unofficially. ASP.NET AJAX becomes useless when using it with ASP.NET MVC. However, using the alternative libraries in MVC require less effort than the traditional way. jQquery and ExtJs are the most notable. Besides, mootools and YUI are also gaining their share. Anyway, Microsoft will push ASP.NET AJAX little ahead those 3rd party library through their Ajax Helper once again.

Recently, I'm getting addicted to Twitter. Since I've moved to my new host, this is a good opportunity to try something new.

Twitter, in fact, does provide a pack of pre-built badges. But they are not my type, 2 flash badges and a html/javascript one. Fortunately, Twitter also provides a set of API over JSON/REST to query almost everything out. After take a look at API, I ended up with an idea to create a new one. I want to display either my friends' or mine in the timeline so I picked 'friend_timeline' method over the 'user_timeline' method because the latter will return only your own tweets. After that, I want the result in JSON therefore I have to ping to http://twitter.com/statuses/friends_timeline/wiennat.json.

Next step is to figure how do I use the json result from twitter. Because of security reason, AJAX call cannot go across the domain. This reason has an impact on me, I can't call to timeline url directly. Then, proxy call came into my head but I hesitated to do it so because I remembered that I found many websites with twitter badges and I was sure they didn't use this technique. After doing some research, I knew the solution, Twitter provides a way to set up a callback by using 'callback' parameter. This reflects a change to target url, http://twitter.com/statuses/friends_timeline/wiennat.json?callback=cbfn (where cbfn is the name of callback function). Instead of only JSON data, using callback parameter causes Twitter to return the JSON data as a parameter of specified function call.

To make it possible in HTML, I wrapped the url in script element and put it at the end of element. I delayed this process by using $(document).ready to wait until DOM is ready before loading the timeline. This prevents the timeline to be loaded while the page still is not loaded completely.

var Twitter = {
_twitter_parent:'',
_tweet_count : 20,
init : function (username, parent, count){
$(document).ready( function() {Twitter.loadTwitter(username); });
Twitter._twitter_parent = parent;
Twitter._tweet_count = count || 20;
}

loadTwitter : function(username){
var ttdata = document.createElement("script")
ttdata.src = 'http://twitter.com/statuses/friends_timeline/'+username+'.json?count='+Twitter._tweet_count + '&callback=Twitter.twcb';
document.body.appendChild(ttdata);
}
.... // still not complete

After append twitter script to the body element, timeline will be loaded and will call the function specified with callback parameter, inthis case Twitter.twcb. Twitter.twcb is a function that processes the returned data and put it in desired element.

twcb : function(ob) {
var twitterpane = $('#' + Twitter._twitter_parent);

ot = '<ul id="'+twitterpane.id+'_inner" class="twpane">';
for (var j=0;j<Twitter._tweet_count ;j++ ) {
at = Twitter.relative_time(ob[j].created_at);
us = ob[j].user.screen_name;
id = ob[j].id;
tx = ob[j].text;
ot += ('<li><span class="twus"><a href="http://twitter.com/' + us + '">'+us+'</a></span>: ' + tx + ' <span class="twdtxt"><a href="http://twitter.com/'+us + '/statuses/'+ id+'">#</a> <small>~'+at+'</small></span></li>');
}
ot += '</ul>';
ot += '<div style="font-size:xx-small;text-align:right">powered by <a href="http://twitter.com">twitter</a></div>';
twitterpane.css('overflow', 'hidden');
twitterpane.css('height',0);
twitterpane.html(ot);
twitterpane.animate({
height: twitterpane[0].scrollHeight
}, 750 );

As for relative time, I copied it out from the twitter badges. Actually, jquery doesn't provide blind effect likes script.aculo.us. To do it so, set the overflow property of desired element to hidden and then animate its dimension to achieve the effect. In this step, I got struck for 4 hrs. because I don't know how to specified target height dynamically. Thank you iPats for his advice on scrollHeight. To run this script, I put the script into external script and initialize the script with this code

<script type="text/javascript" src="/misc/twitterj.js"></script>
<script type="text/javascript">
$(document).ready(function() {
Twitter.init('wiennat', 'itwitterpane', 7); });
</script>
<div id="itwitterpane"> <img src="/images/spinner.gif" />loading... </div>

That's not too hard for me to create such a simple badge like this.