{"name":"toggle","type":"method","title":".toggle()","deprecated":null,"removed":null,"desc":"Display or hide the matched elements.","categories":["effects/basics","version/1.0","version/1.3","version/1.4.3"],"entries":[{"return":"jQuery","signatures":[{"added":"1.0","argument":[{"desc":"A string or number determining how long the animation will run.","type":[{"name":"Number"},{"name":"String"}],"name":"duration","default":"400","optional":"true"},{"desc":"A function to call once the animation is complete.","name":"complete","type":"Function","optional":"true"}]},{"added":"1.0","argument":{"desc":"A map of additional options to pass to the method.","property":[{"desc":"A string or number determining how long the animation will run.","type":[{"name":"Number"},{"name":"String"}],"name":"duration","default":"400"},{"desc":"A string indicating which easing function to use for the transition.","name":"easing","type":"String","default":"swing"},{"desc":"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. When a custom queue name is used the animation does not automatically start; you must call .dequeue(\"queuename\") to start it.","type":[{"name":"Boolean"},{"name":"String"}],"name":"queue","default":"true"},{"desc":"A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions.","name":"specialEasing","type":"PlainObject","added":"1.4"},{"desc":"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.","argument":[{"desc":"The numeric value of the property being animated at each step","name":"now","type":"Number"},{"desc":"An object of properties related to the animation and the element being animated. For information about the tween object and its properties, see jQuery.Tween","name":"tween","type":"Tween"}],"name":"step","type":"Function"},{"desc":"A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.","argument":[{"desc":"An enhanced Promise object with additional properties for the animation","name":"animation","type":"Promise"},{"desc":"A number from 0 to 1 indicating the progress of the animation","name":"progress","type":"Number"},{"desc":"A number indicating the remaining number of milliseconds until the scheduled end of the animation","name":"remainingMs","type":"Number"}],"name":"progress","type":"Function","added":"1.8"},{"desc":"A function to call once the animation is complete.","name":"complete","type":"Function"},{"desc":"A function to call when the animation begins.","argument":{"desc":"An enhanced Promise object with additional properties for the animation","name":"animation","type":"Promise"},"name":"start","type":"Function","added":"1.8"},{"desc":"A function to be called when the animation completes (its Promise object is resolved).","argument":[{"desc":"An enhanced Promise object with additional properties for the animation","name":"animation","type":"Promise"},{"desc":"Indicates whether the animation jumped to the end","name":"jumpedToEnd","type":"Boolean"}],"name":"done","type":"Function","added":"1.8"},{"desc":"A function to be called when the animation fails to complete (its Promise object is rejected).","argument":[{"desc":"An enhanced Promise object with additional properties for the animation","name":"animation","type":"Promise"},{"desc":"Indicates whether the animation jumped to the end","name":"jumpedToEnd","type":"Boolean"}],"name":"fail","type":"Function","added":"1.8"},{"desc":"A function to be called when the animation completes or stops without completing (its Promise object is either resolved or rejected).","argument":[{"desc":"An enhanced Promise object with additional properties for the animation","name":"animation","type":"Promise"},{"desc":"Indicates whether the animation jumped to the end","name":"jumpedToEnd","type":"Boolean"}],"name":"always","type":"Function","added":"1.8"}],"name":"options","type":"PlainObject"}},{"added":"1.4.3","argument":[{"desc":"A string or number determining how long the animation will run.","type":[{"name":"Number"},{"name":"String"}],"name":"duration","default":"400"},{"desc":"A string indicating which easing function to use for the transition.","name":"easing","type":"String","default":"swing","optional":"true"},{"desc":"A function to call once the animation is complete.","name":"complete","type":"Function","optional":"true"}]},{"added":"1.3","argument":{"desc":"A Boolean indicating whether to show or hide the elements.","name":"showOrHide","type":"Boolean"}}],"examples":[{"desc":"Toggles all paragraphs.","code":"\n$( \"button\" ).click(function() {\n $( \"p\" ).toggle();\n});\n","html":"\n\n

Hello

\n

Good Bye

\n"},{"desc":"Animates all paragraphs to be shown if they are hidden and hidden if they are visible, completing the animation within 600 milliseconds.","code":"\n$( \"button\" ).click(function() {\n $( \"p\" ).toggle( \"slow\" );\n});\n","css":"\n p {\n background: #dad;\n font-weight: bold;\n font-size: 16px;\n }\n","html":"\n\n

Hiya

\n

Such interesting text, eh?

\n"},{"desc":"Shows all paragraphs, then hides them all, back and forth.","code":"\nvar flip = 0;\n$( \"button\" ).click(function() {\n $( \"p\" ).toggle( flip++ % 2 === 0 );\n});\n","html":"\n\n

Hello

\n

Good Bye

\n"}],"longdesc":"\n
\n

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

\n
\n

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

\n 
\n$( \".target\" ).toggle();\n
\n

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.

\n

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.

\n

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.

\n

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.

\n

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.

\n

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

\n 
\n<div id=\"clickme\">\n  Click here\n</div>\n<img id=\"book\" src=\"book.png\" alt=\"\" width=\"100\" height=\"123\">\n
\n

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

\n 
\n$( \"#clickme\" ).click(function() {\n  $( \"#book\" ).toggle( \"slow\", function() {\n    // Animation complete.\n  });\n});\n
\n

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

\n

\n \"\"/\n \"\"/\n \"\"/\n \"\"/\n

\n

A second click will show the element once again:

\n

\n \"\"/\n \"\"/\n \"\"/\n \"\"/\n

\n

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:\n

\n 
\n$( \"#foo\" ).toggle( showOrHide );\n
\n

is equivalent to:

\n 
\nif ( showOrHide === true ) {\n  $( \"#foo\" ).show();\n} else if ( showOrHide === false ) {\n  $( \"#foo\" ).hide();\n}\n
\n "}]}