.ajaxStop()
.ajaxStop( handler() ) Returns: jQuery
Description: Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.
-
version added: 1.0.ajaxStop( handler() )
handler()The function to be invoked.
Whenever an Ajax request completes, jQuery checks whether there are any other outstanding Ajax requests. If none remain, jQuery triggers the ajaxStop
event. Any and all handlers that have been registered with the .ajaxStop()
method are executed at this time. The ajaxStop
event is also triggered if the last outstanding Ajax request is cancelled by returning false within the beforeSend
callback function.
To observe this method in action, we can set up a basic Ajax load request:
<div class="trigger">Trigger</div> <div class="result"></div> <div class="log"></div>
We can attach our event handler to any element:
$('.log').ajaxStop(function() { $(this).text('Triggered ajaxStop handler.'); });
Now, we can make an Ajax request using any jQuery method:
$('.trigger').click(function() { $('.result').load('ajax/test.html'); });
When the user clicks the button and the Ajax request completes, the log message is displayed.
Because .ajaxStop()
is implemented as a method of jQuery object instances, we can use the this
keyword as we do here to refer to the selected elements within the callback function.
Example:
Hide a loading message after all the Ajax requests have stopped.
$("#loading").ajaxStop(function(){
$(this).hide();
});