.toggle()

jQuery

previous page next page

.toggle()

Categories: Effects > Basics

.toggle( [duration ] [, complete ] ) Returns: jQuery

Description: Display or hide the matched elements.

  • version added: 1.0.toggle( [duration ] [, complete ] )

    • duration (default: 400)
      Type: Number or String
      A string or number determining how long the animation will run.
    • complete
      Type: Function()
      A function to call once the animation is complete.

  • version added: 1.0.toggle( options )

    • options
      Type: PlainObject
      A map of additional options to pass to the method.
      • duration (default: 400)
        Type: Number or String
        A string or number determining how long the animation will run.
      • easing (default: swing)
        Type: String
        A string indicating which easing function to use for the transition.
      • queue (default: true)
        Type: Boolean
        A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.
      • specialEasing
        Type: PlainObject
        A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions. (version added: 1.4)
      • step
        Type: Function( Number now, Tween tween )
        A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.
      • progress
        Type: Function( Promise animation, Number progress, Number remainingMs )
        A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties. (version added: 1.8)
      • complete
        Type: Function()
        A function to call once the animation is complete.
      • done
        Type: Function( Promise animation, Boolean jumpedToEnd )
        A function to be called when the animation completes (its Promise object is resolved). (version added: 1.8)
      • fail
        Type: Function( Promise animation, Boolean jumpedToEnd )
        A function to be called when the animation fails to complete (its Promise object is rejected). (version added: 1.8)
      • always
        Type: Function( Promise animation, Boolean jumpedToEnd )
        A function to be called when the animation completes or stops without completing (its Promise object is either resolved or rejected). (version added: 1.8)

  • version added: 1.4.3.toggle( [duration ] [, easing ] [, complete ] )

    • duration (default: 400)
      Type: Number or String
      A string or number determining how long the animation will run.
    • easing (default: swing)
      Type: String
      A string indicating which easing function to use for the transition.
    • complete
      Type: Function()
      A function to call once the animation is complete.

  • version added: 1.3.toggle( showOrHide )

    • showOrHide
      Type: Boolean
      A Boolean indicating whether to show or hide the elements.

Note: The event handling suite also has a method named .toggle(). Which one is fired depends on the set of arguments passed.

With no parameters, the .toggle() method simply toggles the visibility of elements:

1
 
                                

                                  

                                    $('.target').toggle();

The matched elements will be revealed or hidden immediately, with no animation, by changing the CSS display property. If the element is initially displayed, it will be hidden; if hidden, it will be shown. The display property is saved and restored as needed. If an element has a display value of inline, then is hidden and shown, it will once again be displayed inline.

When a duration, a plain object, or a single "complete" function is provided, .toggle() becomes an animation method. The .toggle() method animates the width, height, and opacity of the matched elements simultaneously. When these properties reach 0 after a hiding animation, the display style property is set to none to ensure that the element no longer affects the layout of the page.

Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings 'fast' and 'slow' can be supplied to indicate durations of 200 and 600 milliseconds, respectively.

As of jQuery 1.4.3, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called swing, and one that progresses at a constant pace, called linear. More easing functions are available with the use of plug-ins, most notably the jQuery UI suite.

If supplied, the callback is fired once the animation is complete. This can be useful for stringing different animations together in sequence. The callback is not sent any arguments, but this is set to the DOM element being animated. If multiple elements are animated, it is important to note that the callback is executed once per matched element, not once for the animation as a whole.

We can animate any element, such as a simple image:

1
2
3
4
 
                                

                                  

                                    
                                      <div id="clickme">
                                    
                                  

                                

                                

                                  

                                      Click here
                                  

                                

                                

                                  

                                    
                                      </div>
                                    
                                  

                                

                                

                                  

                                    
                                      <img id="book" src="book.png" alt="" width="100" height="123" />

We will cause .toggle() to be called when another element is clicked:

1
2
3
4
5
 
                                

                                  

                                    $('#clickme').click(function() {
                                  

                                

                                

                                  

                                      $('#book').toggle('slow', function() {
                                  

                                

                                

                                  

                                        // Animation complete.
                                  

                                

                                

                                  

                                      });
                                  

                                

                                

                                  

                                    });

With the element initially shown, we can hide it slowly with the first click:

A second click will show the element once again:

The second version of the method accepts a Boolean parameter. If this parameter is true, then the matched elements are shown; if false, the elements are hidden. In essence, the statement:

1
 
                                

                                  

                                    $('#foo').toggle(showOrHide);

is equivalent to:

1
2
3
4
5
 
                                

                                  

                                    if ( showOrHide == true ) {
                                  

                                

                                

                                  

                                      $('#foo').show();
                                  

                                

                                

                                  

                                    } else if ( showOrHide == false ) {
                                  

                                

                                

                                  

                                      $('#foo').hide();
                                  

                                

                                

                                  

                                    }

Additional Notes:

  • All jQuery effects, including .toggle(), can be turned off globally by setting jQuery.fx.off = true, which effectively sets the duration to 0. For more information, see jQuery.fx.off.

Examples:

Example: Toggles all paragraphs.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <button>Toggle</button>
                                    

                                  

                                  

                                    

                                      <p>Hello</p>
                                    

                                  

                                  

                                    

                                      <p style="display: none">Good Bye</p>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      $("button").click(function () {
                                    

                                  

                                  

                                    

                                      $("p").toggle();
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>

Example: Animates all paragraphs to be shown if they are hidden and hidden if they are visible, completing the animation within 600 milliseconds.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <style>
                                    

                                  

                                  

                                    

                                      p { background:#dad;
                                    

                                  

                                  

                                    

                                      
                                        font-weight:bold;
                                      
                                    

                                  

                                  

                                    

                                      font-size:16px; }
                                    

                                  

                                  

                                    

                                      
                                        </style>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <button>Toggle 'em</button>
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      <p>Hiya</p>
                                    

                                  

                                  

                                    

                                      <p>Such interesting text, eh?</p>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                      $("button").click(function () {
                                    

                                  

                                  

                                    

                                      $("p").toggle("slow");
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>

Example: Shows all paragraphs, then hides them all, back and forth.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <button>Toggle</button>
                                    

                                  

                                  

                                    

                                      <p>Hello</p>
                                    

                                  

                                  

                                    

                                      <p style="display: none">Good Bye</p>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                      var flip = 0;
                                    

                                  

                                  

                                    

                                      $("button").click(function () {
                                    

                                  

                                  

                                    

                                      $("p").toggle( flip++ % 2 == 0 );
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>
 POWERED BYHERONOTE
previous page start next page