.toggle( effect [, options ] [, duration ] [, complete ] )Returns: jQuery
Description: Display or hide the matched elements, using custom effects.
-
.toggle( effect [, options ] [, duration ] [, complete ] )
- effectType: StringA string indicating which effect to use for the transition.
- optionsType: ObjectEffect-specific properties and easing.
- duration (default:
400
)A string or number determining how long the animation will run. - completeType: Function()A function to call once the animation is complete, called once per matched element.
-
-
.toggle( options )
- optionsType: ObjectAll animation settings. The only required property is
effect
.- effectType: StringA string indicating which effect to use for the transition.
- easing (default:
"swing"
)Type: StringA string indicating which easing function to use for the transition. - duration (default:
400
)A string or number determining how long the animation will run. - completeType: Function()A function to call once the animation is complete, called once per matched element.
- queue (default:
true
)A Boolean indicating whether to place the animation in the effects queue. Iffalse
, the animation will begin immediately. A string can also be provided, in which case the animation is added to the queue represented by that string.
-
-
This plugin extends jQuery's built-in .toggle()
method. If jQuery UI is not loaded, calling the .toggle()
method may not fail directly, as the method still exists. However, the expected behavior will not occur.
Example:
Toggle a div using the fold effect.
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>toggle demo</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.12.0/themes/smoothness/jquery-ui.css"> <style> div { width: 100px; height: 100px; background: #ccc; border: 1px solid #000; } </style> <script src="//code.jquery.com/jquery-1.12.4.js"></script> <script src="//code.jquery.com/ui/1.12.0/jquery-ui.js"></script> </head> <body> <button>toggle the div</button> <div></div> <script> $( "button" ).click(function() { $( "div" ).toggle( "fold", 1000 ); }); </script> </body> </html>