jQuery.dequeue()

jQuery.dequeue ( element, queueName ) Returns: undefinedversion added: 1.3

  • element
    Type: Element
    A DOM element from which to remove and execute a queued function.
  • queueName
    Type: String
    A string containing the name of the queue. Defaults to fx, the standard effects queue.

Description: Execute the next function on the queue for the matched element.

Note: This is a low-level method, you should probably use .dequeue() instead.

When jQuery.dequeue() is called, the next function on the queue is removed from the queue, and then executed. This function should in turn (directly or indirectly) cause jQuery.dequeue() to be called, so that the sequence can continue.

Examples:

Example: Use jQuery.dequeue() to end a custom queue function which allows the queue to keep going. 

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>css demo</title>

  <style>

  div {
    margin: 3px;
    width: 50px;
    position: absolute;
    height: 50px;
    left: 10px;
    top: 30px;
    background-color: yellow;
  }
  div.red {
    background-color: red;
  }

  </style>

  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
</head>
<body>
  

<button>Start</button>
<div></div>

<script>

$( "button" ).click(function() {
  $( "div" )
    .animate({ left: '+=200px' }, 2000 )
    .animate({ top: '0px' }, 600 )
    .queue(function() {
      $( this ).toggleClass( "red" );
      $.dequeue( this );
    })
    .animate({ left:'10px', top:'30px' }, 700 );
});

</script>

  
</body>
</html>

Demo: