4 * Load HTML from a remote file and inject it into the DOM, only if it's
5 * been modified by the server.
7 * @example $("#feeds").loadIfModified("feeds.html");
8 * @before <div id="feeds"></div>
9 * @result <div id="feeds"><b>45</b> feeds found.</div>
11 * @name loadIfModified
13 * @param String url The URL of the HTML file to load.
14 * @param Map params (optional) Key/value pairs that will be sent to the server.
15 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
18 loadIfModified: function( url, params, callback ) {
19 this.load( url, params, callback, 1 );
23 * Load HTML from a remote file and inject it into the DOM.
25 * Note: Avoid to use this to load scripts, instead use $.getScript.
26 * IE strips script tags when there aren't any other characters in front of it.
28 * @example $("#feeds").load("feeds.html");
29 * @before <div id="feeds"></div>
30 * @result <div id="feeds"><b>45</b> feeds found.</div>
32 * @example $("#feeds").load("feeds.html",
34 * function() { alert("The last 25 entries in the feed have been loaded"); }
36 * @desc Same as above, but with an additional parameter
37 * and a callback that is executed when the data was loaded.
41 * @param String url The URL of the HTML file to load.
42 * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
43 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
46 load: function( url, params, callback, ifModified ) {
47 if ( jQuery.isFunction( url ) )
48 return this.bind("load", url);
50 callback = callback || function(){};
52 // Default to a GET request
55 // If the second parameter was provided
58 if ( jQuery.isFunction( params ) ) {
59 // We assume that it's the callback
63 // Otherwise, build a param string
65 params = jQuery.param( params );
71 // Request the remote document
76 ifModified: ifModified,
77 complete: function(res, status){
78 // If successful, inject the HTML into all the matched elements
79 if ( status == "success" || !ifModified && status == "notmodified" )
80 self.html(res.responseText)
82 self.each( callback, [res.responseText, status, res] );
89 * Serializes a set of input elements into a string of data.
90 * This will serialize all given elements.
92 * A serialization similar to the form submit of a browser is
93 * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
94 * It also takes multiple-selects
95 * into account, while this method recognizes only a single option.
97 * @example $("input[@type=text]").serialize();
98 * @before <input type='text' name='name' value='John'/>
99 * <input type='text' name='location' value='Boston'/>
100 * @after name=John&location=Boston
101 * @desc Serialize a selection of input elements to a string
107 serialize: function() {
108 return jQuery.param( this );
113 // Attach a bunch of functions for handling common AJAX events
116 * Attach a function to be executed whenever an AJAX request begins
117 * and there is none already active.
119 * @example $("#loading").ajaxStart(function(){
122 * @desc Show a loading message whenever an AJAX request starts
123 * (and none is already active).
127 * @param Function callback The function to execute.
132 * Attach a function to be executed whenever all AJAX requests have ended.
134 * @example $("#loading").ajaxStop(function(){
137 * @desc Hide a loading message after all the AJAX requests have stopped.
141 * @param Function callback The function to execute.
146 * Attach a function to be executed whenever an AJAX request completes.
148 * The XMLHttpRequest and settings used for that request are passed
149 * as arguments to the callback.
151 * @example $("#msg").ajaxComplete(function(request, settings){
152 * $(this).append("<li>Request Complete.</li>");
154 * @desc Show a message when an AJAX request completes.
158 * @param Function callback The function to execute.
163 * Attach a function to be executed whenever an AJAX request completes
166 * The XMLHttpRequest and settings used for that request are passed
167 * as arguments to the callback.
169 * @example $("#msg").ajaxSuccess(function(request, settings){
170 * $(this).append("<li>Successful Request!</li>");
172 * @desc Show a message when an AJAX request completes successfully.
176 * @param Function callback The function to execute.
181 * Attach a function to be executed whenever an AJAX request fails.
183 * The XMLHttpRequest and settings used for that request are passed
184 * as arguments to the callback. A third argument, an exception object,
185 * is passed if an exception occured while processing the request.
187 * @example $("#msg").ajaxError(function(request, settings){
188 * $(this).append("<li>Error requesting page " + settings.url + "</li>");
190 * @desc Show a message when an AJAX request fails.
194 * @param Function callback The function to execute.
199 * Attach a function to be executed before an AJAX request is sent.
201 * The XMLHttpRequest and settings used for that request are passed
202 * as arguments to the callback.
204 * @example $("#msg").ajaxSend(function(request, settings){
205 * $(this).append("<li>Starting request at " + settings.url + "</li>");
207 * @desc Show a message before an AJAX request is sent.
211 * @param Function callback The function to execute.
214 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
215 jQuery.fn[o] = function(f){
216 return this.bind(o, f);
223 * Load a remote page using an HTTP GET request.
225 * This is an easy way to send a simple GET request to a server
226 * without having to use the more complex $.ajax function. It
227 * allows a single callback function to be specified that will
228 * be executed when the request is complete (and only if the response
229 * has a successful response code). If you need to have both error
230 * and success callbacks, you may want to use $.ajax.
232 * @example $.get("test.cgi");
234 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
236 * @example $.get("test.cgi", function(data){
237 * alert("Data Loaded: " + data);
240 * @example $.get("test.cgi",
241 * { name: "John", time: "2pm" },
243 * alert("Data Loaded: " + data);
248 * @type XMLHttpRequest
249 * @param String url The URL of the page to load.
250 * @param Map params (optional) Key/value pairs that will be sent to the server.
251 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
254 get: function( url, data, callback, type, ifModified ) {
255 // shift arguments if data argument was ommited
256 if ( jQuery.isFunction( data ) ) {
267 ifModified: ifModified
272 * Load a remote page using an HTTP GET request, only if it hasn't
273 * been modified since it was last retrieved.
275 * @example $.getIfModified("test.html");
277 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
279 * @example $.getIfModified("test.cgi", function(data){
280 * alert("Data Loaded: " + data);
283 * @example $.getifModified("test.cgi",
284 * { name: "John", time: "2pm" },
286 * alert("Data Loaded: " + data);
290 * @name $.getIfModified
291 * @type XMLHttpRequest
292 * @param String url The URL of the page to load.
293 * @param Map params (optional) Key/value pairs that will be sent to the server.
294 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
297 getIfModified: function( url, data, callback, type ) {
298 return jQuery.get(url, data, callback, type, 1);
302 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
304 * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
305 * context synchronously. If you load functions via getScript, make sure
306 * to call them after a delay.
308 * @example $.getScript("test.js");
310 * @example $.getScript("test.js", function(){
311 * alert("Script loaded and executed.");
315 * @type XMLHttpRequest
316 * @param String url The URL of the page to load.
317 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
320 getScript: function( url, callback ) {
321 return jQuery.get(url, null, callback, "script");
325 * Load JSON data using an HTTP GET request.
327 * @example $.getJSON("test.js", function(json){
328 * alert("JSON Data: " + json.users[3].name);
331 * @example $.getJSON("test.js",
332 * { name: "John", time: "2pm" },
334 * alert("JSON Data: " + json.users[3].name);
339 * @type XMLHttpRequest
340 * @param String url The URL of the page to load.
341 * @param Map params (optional) Key/value pairs that will be sent to the server.
342 * @param Function callback A function to be executed whenever the data is loaded successfully.
345 getJSON: function( url, data, callback ) {
346 return jQuery.get(url, data, callback, "json");
350 * Load a remote page using an HTTP POST request.
352 * @example $.post("test.cgi");
354 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
356 * @example $.post("test.cgi", function(data){
357 * alert("Data Loaded: " + data);
360 * @example $.post("test.cgi",
361 * { name: "John", time: "2pm" },
363 * alert("Data Loaded: " + data);
368 * @type XMLHttpRequest
369 * @param String url The URL of the page to load.
370 * @param Map params (optional) Key/value pairs that will be sent to the server.
371 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
374 post: function( url, data, callback, type ) {
375 if ( jQuery.isFunction( data ) ) {
390 * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
391 * This will make all future AJAX requests timeout after a specified amount
394 * Set to null or 0 to disable timeouts (default).
396 * You can manually abort requests with the XMLHttpRequest's (returned by
397 * all ajax functions) abort() method.
399 * Deprecated. Use $.ajaxSetup instead.
401 * @example $.ajaxTimeout( 5000 );
402 * @desc Make all AJAX requests timeout after 5 seconds.
404 * @name $.ajaxTimeout
406 * @param Number time How long before an AJAX request times out, in milliseconds.
409 ajaxTimeout: function( timeout ) {
410 jQuery.ajaxSettings.timeout = timeout;
414 * Setup global settings for AJAX requests.
416 * See $.ajax for a description of all available options.
418 * @example $.ajaxSetup( {
423 * $.ajax({ data: myData });
424 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
425 * disables global handlers and uses POST instead of GET. The following
426 * AJAX requests then sends some data without having to set anything else.
430 * @param Map settings Key/value pairs to use for all AJAX requests
433 ajaxSetup: function( settings ) {
434 jQuery.extend( jQuery.ajaxSettings, settings );
441 contentType: "application/x-www-form-urlencoded",
447 // Last-Modified header cache for next request
451 * Load a remote page using an HTTP request.
453 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
454 * higher-level abstractions that are often easier to understand and use,
455 * but don't offer as much functionality (such as error callbacks).
457 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
458 * need that object to manipulate directly, but it is available if you need to
459 * abort the request manually.
461 * '''Note:''' If you specify the dataType option described below, make sure
462 * the server sends the correct MIME type in the response (eg. xml as "text/xml").
463 * Sending the wrong MIME type can lead to unexpected problems in your script.
464 * See [[Specifying the Data Type for AJAX Requests]] for more information.
466 * Supported datatypes are (see dataType option):
468 * "xml": Returns a XML document that can be processed via jQuery.
470 * "html": Returns HTML as plain text, included script tags are evaluated.
472 * "script": Evaluates the response as Javascript and returns it as plain text.
474 * "json": Evaluates the response as JSON and returns a Javascript Object
476 * $.ajax() takes one argument, an object of key/value pairs, that are
477 * used to initalize and handle the request. These are all the key/values that can
480 * (String) url - The URL to request.
482 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
484 * (String) dataType - The type of data that you're expecting back from
485 * the server. No default: If the server sends xml, the responseXML, otherwise
486 * the responseText is passed to the success callback.
488 * (Boolean) ifModified - Allow the request to be successful only if the
489 * response has changed since the last request. This is done by checking the
490 * Last-Modified header. Default value is false, ignoring the header.
492 * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
493 * single request a longer timeout while all others timeout after 1 second.
494 * See $.ajaxTimeout() for global timeouts.
496 * (Boolean) global - Whether to trigger global AJAX event handlers for
497 * this request, default is true. Set to false to prevent that global handlers
498 * like ajaxStart or ajaxStop are triggered.
500 * (Function) error - A function to be called if the request fails. The
501 * function gets passed tree arguments: The XMLHttpRequest object, a
502 * string describing the type of error that occurred and an optional
503 * exception object, if one occured.
505 * (Function) success - A function to be called if the request succeeds. The
506 * function gets passed one argument: The data returned from the server,
507 * formatted according to the 'dataType' parameter.
509 * (Function) complete - A function to be called when the request finishes. The
510 * function gets passed two arguments: The XMLHttpRequest object and a
511 * string describing the type of success of the request.
513 * (Object|String) data - Data to be sent to the server. Converted to a query
514 * string, if not already a string. Is appended to the url for GET-requests.
515 * See processData option to prevent this automatic processing.
517 * (String) contentType - When sending data to the server, use this content-type.
518 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
520 * (Boolean) processData - By default, data passed in to the data option as an object
521 * other as string will be processed and transformed into a query string, fitting to
522 * the default content-type "application/x-www-form-urlencoded". If you want to send
523 * DOMDocuments, set this option to false.
525 * (Boolean) async - By default, all requests are sent asynchronous (set to true).
526 * If you need synchronous requests, set this option to false.
528 * (Function) beforeSend - A pre-callback to set custom headers etc., the
529 * XMLHttpRequest is passed as the only argument.
536 * @desc Load and execute a JavaScript file.
541 * data: "name=John&location=Boston",
542 * success: function(msg){
543 * alert( "Data Saved: " + msg );
546 * @desc Save some data to the server and notify the user once its complete.
548 * @example var html = $.ajax({
552 * @desc Loads data synchronously. Blocks the browser while the requests is active.
553 * It is better to block user interaction by other means when synchronization is
556 * @example var xmlDocument = [create xml document];
559 * processData: false,
561 * success: handleResponse
563 * @desc Sends an xml document as data to the server. By setting the processData
564 * option to false, the automatic conversion of data to strings is prevented.
567 * @type XMLHttpRequest
568 * @param Map properties Key/value pairs to initialize the request with.
570 * @see ajaxSetup(Map)
572 ajax: function( s ) {
573 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
574 s = jQuery.extend({}, jQuery.ajaxSettings, s);
578 // convert data if not already a string
579 if (s.processData && typeof s.data != "string")
580 s.data = jQuery.param(s.data);
581 // append data to url for get requests
582 if( s.type.toLowerCase() == "get" ) {
583 // "?" + data or "&" + data (in case there are already params)
584 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
585 // IE likes to send both get and post data, prevent this
590 // Watch for a new set of requests
591 if ( s.global && ! jQuery.active++ )
592 jQuery.event.trigger( "ajaxStart" );
594 var requestDone = false;
596 // Create the request object; Microsoft failed to properly
597 // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
598 var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : new XMLHttpRequest();
601 xml.open(s.type, s.url, s.async);
603 // Set the correct header, if data is being sent
605 xml.setRequestHeader("Content-Type", s.contentType);
607 // Set the If-Modified-Since header, if ifModified mode.
609 xml.setRequestHeader("If-Modified-Since",
610 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
612 // Set header so the called script knows that it's an XMLHttpRequest
613 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
615 // Allow custom headers/mimetypes
620 jQuery.event.trigger("ajaxSend", [xml, s]);
622 // Wait for a response to come back
623 var onreadystatechange = function(isTimeout){
624 // The transfer is complete and the data is available, or the request timed out
625 if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
628 // clear poll interval
636 status = isTimeout == "timeout" && "timeout" ||
637 !jQuery.httpSuccess( xml ) && "error" ||
638 s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
641 // Make sure that the request was successful or notmodified
642 if ( status != "error" && status != "timeout" ) {
643 // Cache Last-Modified header, if ifModified mode.
646 modRes = xml.getResponseHeader("Last-Modified");
647 } catch(e) {} // swallow exception thrown by FF if header is not available
649 if ( s.ifModified && modRes )
650 jQuery.lastModified[s.url] = modRes;
652 // process the data (runs the xml through httpData regardless of callback)
653 var data = jQuery.httpData( xml, s.dataType );
655 // If a local callback was specified, fire it and pass it the data
657 s.success( data, status );
659 // Fire the global callback
661 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
663 jQuery.handleError(s, xml, status);
666 jQuery.handleError(s, xml, status, e);
669 // The request was completed
671 jQuery.event.trigger( "ajaxComplete", [xml, s] );
673 // Handle the global AJAX counter
674 if ( s.global && ! --jQuery.active )
675 jQuery.event.trigger( "ajaxStop" );
679 s.complete(xml, status);
687 // don't attach the handler to the request, just poll it instead
688 var ival = setInterval(onreadystatechange, 13);
692 setTimeout(function(){
693 // Check to see if the request is still happening
695 // Cancel the request
699 onreadystatechange( "timeout" );
707 jQuery.handleError(s, xml, null, e);
710 // firefox 1.5 doesn't fire statechange for sync requests
712 onreadystatechange();
714 // return XMLHttpRequest to allow aborting the request etc.
718 handleError: function( s, xml, status, e ) {
719 // If a local callback was specified, fire it
720 if ( s.error ) s.error( xml, status, e );
722 // Fire the global callback
724 jQuery.event.trigger( "ajaxError", [xml, s, e] );
727 // Counter for holding the number of active queries
730 // Determines if an XMLHttpRequest was successful or not
731 httpSuccess: function( r ) {
733 return !r.status && location.protocol == "file:" ||
734 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
735 jQuery.browser.safari && r.status == undefined;
740 // Determines if an XMLHttpRequest returns NotModified
741 httpNotModified: function( xml, url ) {
743 var xmlRes = xml.getResponseHeader("Last-Modified");
745 // Firefox always returns 200. check Last-Modified date
746 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
747 jQuery.browser.safari && xml.status == undefined;
752 /* Get the data out of an XMLHttpRequest.
753 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
754 * otherwise return plain text.
755 * (String) data - The type of data that you're expecting back,
756 * (e.g. "xml", "html", "script")
758 httpData: function( r, type ) {
759 var ct = r.getResponseHeader("content-type");
760 var data = !type && ct && ct.indexOf("xml") >= 0;
761 data = type == "xml" || data ? r.responseXML : r.responseText;
763 // If the type is "script", eval it in global context
764 if ( type == "script" )
765 (new Function( data ))();
767 // Get the JavaScript object, if JSON is used.
768 if ( type == "json" )
769 data = eval("(" + data + ")");
774 // Serialize an array of form elements or a set of
775 // key/values into a query string
776 param: function( a ) {
779 // If an array was passed in, assume that it is an array
781 if ( a.constructor == Array || a.jquery )
782 // Serialize the form elements
783 jQuery.each( a, function(){
784 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
787 // Otherwise, assume that it's an object of key/value pairs
789 // Serialize the key/values
791 // If the value is an array then the key names need to be repeated
792 if ( a[j] && a[j].constructor == Array )
793 jQuery.each( a[j], function(){
794 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
797 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
799 // Return the resulting serialization