.ajaxComplete()

jQuery

previous page next page

.ajaxComplete()

Categories: Ajax > Global Ajax Event Handlers

.ajaxComplete( handler(event, XMLHttpRequest, ajaxOptions) ) Returns: jQuery

Description: Register a handler to be called when Ajax requests complete. This is an AjaxEvent.

  • version added: 1.0.ajaxComplete( handler(event, XMLHttpRequest, ajaxOptions) )

    • handler(event, XMLHttpRequest, ajaxOptions)
      Type: Function()
      The function to be invoked.

Whenever an Ajax request completes, jQuery triggers the ajaxComplete event. Any and all handlers that have been registered with the .ajaxComplete() method are executed at this time.

To observe this method in action, set up a basic Ajax load request:

1
2
3
 
                                

                                  

                                    <div class="trigger">Trigger</div>
                                  

                                

                                

                                  

                                    
                                      <div class="result">
                                      </div>
                                    
                                  

                                

                                

                                  

                                    
                                      <div class="log">
                                      </div>

Attach the event handler to the document:

1
2
3
 
                                

                                  

                                    $(document).ajaxComplete(function() {
                                  

                                

                                

                                  

                                      $( ".log" ).text( "Triggered ajaxComplete handler." );
                                  

                                

                                

                                  

                                    });

Now, make an Ajax request using any jQuery method:

1
2
3
 
                                

                                  

                                    $( ".trigger" ).click(function() {
                                  

                                

                                

                                  

                                      $( ".result" ).load( "ajax/test.html" );
                                  

                                

                                

                                  

                                    });

When the user clicks the element with class trigger and the Ajax request completes, the log message is displayed.

Note: Because .ajaxComplete() is implemented as a method of jQuery object instances, you can use the this keyword to refer to the selected elements within the callback function. As of jQuery 1.8, however, the .ajaxComplete() method should only be attached to document.

All ajaxComplete handlers are invoked, regardless of what Ajax request was completed. If you must differentiate between the requests, use the parameters passed to the handler. Each time an ajaxComplete handler is executed, it is passed the event object, the XMLHttpRequest object, and the settings object that was used in the creation of the request. For example, you can restrict the callback to only handling events dealing with a particular URL:

1
2
3
4
5
6
 
                                

                                  

                                    $(document).ajaxComplete(function(event, xhr, settings) {
                                  

                                

                                

                                  

                                      if ( settings.url === "ajax/test.html" ) {
                                  

                                

                                

                                  

                                        $( ".log" ).text( "Triggered ajaxComplete handler. The result is " +
                                  

                                

                                

                                  

                                                         xhr.responseHTML );
                                  

                                

                                

                                  

                                      }
                                  

                                

                                

                                  

                                    });

Note: You can get the returned ajax contents by looking at xhr.responseXML or xhr.responseHTML for xml and html respectively.

Additional Notes:

  • If $.ajax() or $.ajaxSetup() is called with the global option set to false, the .ajaxComplete() method will not fire.

Example:

Show a message when an Ajax request completes.

1
2
3
 
                                  

                                    

                                      $(document).ajaxComplete(function(event,request, settings) {
                                    

                                  

                                  

                                    

                                         $( "#msg" ).append( "<li>Request Complete.</li>" );
                                    

                                  

                                  

                                    

                                       });
 POWERED BYHERONOTE
previous page start next page