jQuery Effects Stop

The stop() Method

The stop() method is used to stop an animation or effect before it is finished.

The stop() method works for all jQuery effect functions, including sliding, fading and custom animations.

Syntax

					 
        
          $(selector).stop(stopAll, goToEnd);
        
      

The optional stopAll parameter specifies whether also the animation queue should be cleared or not. Default is false, which means that only the active animation will be stopped, allowing any queued animations to be performed afterwards.

The optional goToEnd parameter specifies whether or not to complete the current animation immediately. Default is false.

So, by default, the stop() method kills the current animation being performed on the selected element.

The following example demonstrates the stop() method, with no parameters:

The stop() method With Parameters

					 
        
          // Action 1: start the animation
          $("#start").click(function(){
            $("div").animate({left: '100px'}, 5000);
            $("div").animate({fontSize: '3em'}, 5000);
          });
  
          // Action 2: stop the animation
          $("#stop").click(function(){
            $("div").stop();
          });

          // Action 3: stop all the animation
          $("#stopAll").click(function(){
            $("div").stop(true);
          });

          // Action 4: stop but finish the animation
          $("#stopButFinish").click(function(){
            $("div").stop(true, true);
          }); 
        
      

The "start" button starts the animation.

The "stop" button stops the current active animation, but allows the queued animations to be performed afterwards.

The "stopAll" button stops the current active animation and clears the animation queue; so all animations on the element is stopped.

The "stopButFinish" rushes through the current active animation, then it stops.