.toggle()

Categories: Effects | Effects Core | Method Overrides | Methods

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

Description: Display or hide the matched elements, using custom effects.

  • .toggle( effect [, options ] [, duration ] [, complete ] )

    • effect
      Type: String
      A string indicating which effect to use for the transition.
    • options
      Type: Object
      Effect-specific settings and easing.
    • 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.

  • .toggle( options )

    • options
      Type: Object
      All animation settings. The only required property is effect.
      • effect
        Type: String
        A string indicating which effect to use for the transition.
      • easing (default: "swing")
        Type: String
        A string indicating which easing function to use for the transition.
      • 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.

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css">
  <style>
  div {
    width: 100px;
    height: 100px;
    background: #ccc;
    border: 1px solid #000;
  }
  </style>
  <script src="//code.jquery.com/jquery-1.8.3.js"></script>
  <script src="//code.jquery.com/ui/1.9.2/jquery-ui.js"></script>
</head>
<body>
 
<button>toggle the div</button>
<div></div>
 
<script>
$( "button" ).click(function() {
  $( "div" ).toggle( "fold", 1000 );
});
</script>
 
</body>
</html>

Demo: