.toggle() JQ Home  <<  Effects  <<  .toggle()

Toggling elements.

Description

The .toggle() method is used to show or hide the matched set.

  • When hiding elements the display property of the elements to be hidden is stored in the jQuery cache, so if the element is later made visible, the display property is restored to its initial value.
  • When showing elements the display property of the element to be shown is restored to its initial value. If using !important in your styles, it is necessary to override the style using .css('display', 'block !important') for the .show() method to function correctly
  • When the duration, easing or callback parameters are used, the .toggle() method becomes an animation method.
  • There is also a mouse event named .toggle() which was deprecated in jQuery 1.8 and removed in jQuery 1.9.

This method was deprecated in jQuery 1.8 and removed in 1.9.

Syntax

Signature Description
.toggle( )Show or hide the matched set.
.toggle( showOrHide )Show or hide the matched set depending upon the boolean value of the parameter.
.toggle( duration [, callback] )Show or hide the matched set providing a duration and optionally a callback function.
.toggle( [duration] [, easing] [, callback] )Show or hide the matched set optionally providing a duration, and/or an easing and/or a callback function.

Parameters

Parameter Description Type
showOrHideA Boolean value.
  • If this equates to true, the matched elements are shown.
  • If this equates to false, the matched elements are hidden.
Boolean
durationA string or number determining the time the animation will run for.
default: 400
  • Durations are given in milliseconds and the higher the value, the slower the animation.
  • The string 'slow' can be used which equates to 600 milliseconds.
  • The string 'fast' can be used which equates to 200 milliseconds.
String or
Number
easingSpecify the speed at which the animation progresses at different points within the animation.
default: swing
  • The string 'swing' which is the default and causes the animation to animate faster at the beginning/end and slower in the middle.
  • The string 'linear' which causes the animation to progress at a constant pace.
String
callbackA function that fires once the animation is complete.
  • The callback is fired in the context of the current element in the set being animated, so the keyword this refers to that element.
  • The callback is fired once for each element in the matched set and can be used to string different animations together in sequence.
 Function

Return

A jQuery object.

.toggle() Example  Effects  <<  Top

Show or hide the matched set.

  • When used in its basic form with no parameters the .toggle() method shows or hides the elements immediately with no animation.

In the example below when the button is pressed we show the image below of thai green curry.

a picture of curry


$(function(){
  $('#btn13').on('click', function() {
    $('#curry7').toggle();
  });
});

Press the buttons below to action the above code:

.toggle( showOrHide ) Example  Effects  <<  Top

Show or hide the the matched set depending upon the boolean value of the parameter.

  • When used in this form the .toggle( showOrHide ) signature shows or hides the elements immediately with no animation.

In the example below when the left button is pressed if the image is shown it will be hidden.

When the right button is pressed when the image is hidden it will be shown.

a picture of curry


$(function(){
  $('#btn14').on('click', function() {
    $('#curry8').toggle(false);
  });
  $('#btn15').on('click', function() {
    $('#curry8').toggle(true);
  });
});

Press the buttons below to action the above code:

     

.toggle( duration [, callback] ) Example  Effects  <<  Top

Show or hide the matched set providing a duration and optionally a callback function.

When we press the left button below is pressed we show or hide the image below on the left of chicken masala using a slow 'duration'.

When the right button is pressed we first select all the images of chicken korma (class of 'curry10'). After this we use the .first() method to extract the first image in the set and pass this through the callback function. Within the function we use the .next() method to cycle through the images, showing or hiding each in turn with a animation speed of 400 milliseconds.

a picture of curry a picture of curry a picture of curry a picture of curry a picture of curry


$(function(){
  $('#btn16').on('click', function() {
    $('#curry9').toggle('slow');
  });
  $('#btn17').on('click', function() {
    $('#div3 .curry10').first().toggle(400, function() {
      // using 'callee' so we don't have to name the function
      $(this).next().toggle(400, arguments.callee);
    });
  });
});

Press the buttons below to action the above code:

          

.toggle( [duration] [, easing] [, callback] ) Example  Effects  <<  Top

Show or hide the the matched set optionally providing a duration, and/or an easing and/or a callback function.

In the example below when the left button is pressed we use 'swing' easing to animate the picture as we show or hide it.

When the centre button is pressed we use a callback to alert when the image is shown or hidden.

When the right button is pressed we use a duration, easing and a callback to alert when the image is shown or hidden.

a picture of curry a picture of curry a picture of curry


$(function(){
  $('#btn18').on('click', function() {
    $('#pie7').toggle('swing');
  });
  $('#btn19').on('click', function() {
    $('#pie8').toggle(function() {
      alert('Animation finished.');
    });
  });
  $('#btn20').on('click', function() {
    $('#pie9').toggle('slow', 'swing', function() {
      alert('Animation complete.');
    });
  });
});

Press the buttons below to action the above code:

               

Related Tutorials

jQuery Intermediate Tutorials - Lesson 6 - Basic & Custom Effects