ajaxStart event | jQuery API Documentation

ajaxStart event

Categories: Ajax > Global Ajax Event Handlers

.on( "ajaxStart", handler )Returns: jQuery

Description: Register a handler to be called when the first Ajax request begins. This is an Ajax Event.

This page describes the ajaxStart event. For the deprecated .ajaxStart() method, see .ajaxStart().

Whenever an Ajax request is about to be sent, jQuery checks whether there are any other outstanding Ajax requests. If none are in progress, jQuery triggers the ajaxStart event. Any and all handlers that have been registered with .on( "ajaxStart", ... ) 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 any element:

1
2
3
 
$( document ).on( "ajaxStart", function() {
  $( ".log" ).text( "Triggered ajaxStart handler." );
} );

Now, make an Ajax request using any jQuery method:

1
2
3
 
$( ".trigger" ).on( "click", function() {
  $( ".result" ).load( "ajax/test.html" );
} );

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

Additional Notes:



  • As of jQuery 1.9, all the handlers for the jQuery global Ajax events, including those added with .on( "ajaxStart", ... ), must be attached to document.
  • If $.ajax() or $.ajaxSetup() is called with the global option set to false, the ajaxStart event will not fire.

Example:

Show a loading message whenever an Ajax request starts (and none is already active).

1
2
3
 
$( document ).on( "ajaxStart", function() {
  $( "#loading" ).show();
} );