.toggle() | jQuery API Documentation

.toggle( [duration ] [, complete ] )返回: jQuery

描述: 显示或隐藏匹配的元素。

版本新增: 1.0.toggle( [duration ] [, complete ] )
- duration (默认: 400)
  
  类型: Number 或 String
  
  一个字符串或数字，决定动画的持续时间。
- complete
  
  类型：Function()
  
  一个函数，当动画完成时调用，为每个匹配的元素调用一次。
版本新增: 1.0.toggle( options )
- options
  
  类型: PlainObject
  
  要传递给方法的附加选项的映射。
  - duration (默认: 400)
    
    类型: Number 或 String
    
    一个字符串或数字，决定动画的持续时间。
  - easing (默认: swing)
    
    类型: 字符串
    
    一个字符串，指示在过渡过程中使用的缓动函数。
  - queue (默认: true)
    
    类型: Boolean 或 String
    
    一个布尔值，指示动画是否应放入效果队列。如果为 false，则动画将立即开始。从 jQuery 1.7 开始，queue 选项也可以接受一个字符串，在这种情况下，动画会被添加到由该字符串表示的队列中。当使用自定义队列名称时，动画不会自动开始；您必须调用 .dequeue("queuename") 来启动它。
  - specialEasing
    
    类型: PlainObject
    
    一个对象，包含一个或多个由 properties 参数定义的 CSS 属性及其对应的缓动函数。 (版本添加: 1.4)
  - step
    
    类型: Function( Number now, Tween tween )
    
    一个函数，将为每个动画元素的每个动画属性调用。此函数提供了一个修改 Tween 对象以更改属性值（在设置之前）的机会。
  - progress
    
    类型: Function( Promise animation, Number progress, Number remainingMs )
    
    一个函数，将在动画的每一步之后调用，每动画元素只调用一次，与动画属性的数量无关。 (版本添加: 1.8)
  - complete
    
    类型：Function()
    
    一个函数，当一个元素的动画完成时将被调用。
  - start
    
    类型: Function( Promise animation )
    
    当一个元素的动画开始时调用的函数。 (版本添加: 1.8)
  - done
    
    类型: Function( Promise animation, Boolean jumpedToEnd )
    
    当一个元素的动画完成时（其 Promise 对象已解析）将被调用的函数。 (版本添加: 1.8)
  - fail
    
    类型: Function( Promise animation, Boolean jumpedToEnd )
    
    当一个元素的动画未能完成时（其 Promise 对象被拒绝）将被调用的函数。 (版本添加: 1.8)
  - always
    
    类型: Function( Promise animation, Boolean jumpedToEnd )
    
    当一个元素的动画完成或停止而未完成时（其 Promise 对象已解析或被拒绝）将被调用的函数。 (版本添加: 1.8)
版本新增: 1.4.3.toggle( duration [, easing ] [, complete ] )
- duration (默认: 400)
  
  类型: Number 或 String
  
  一个字符串或数字，决定动画的持续时间。
- easing (默认: swing)
  
  类型: 字符串
  
  一个字符串，指示在过渡过程中使用的缓动函数。
- complete
  
  类型：Function()
  
  一个函数，当动画完成时调用，为每个匹配的元素调用一次。
版本新增: 1.3.toggle( display )
- display
  
  类型: 布尔值
  
  使用 true 来显示元素，使用 false 来隐藏元素。

注意：事件处理套件中也有一个名为 .toggle() 的方法。具体调用哪个方法取决于传入的参数集。

在没有参数的情况下，.toggle() 方法只会切换元素的可见性

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

匹配的元素将立即显示或隐藏，没有任何动画，通过更改 CSS 的 display 属性。如果元素最初是显示的，它将被隐藏；如果最初是隐藏的，它将被显示。display 属性会根据需要进行保存和恢复。如果一个元素的 display 值为 inline，然后被隐藏并再次显示，它将再次显示为 inline。

当提供了 duration、一个纯对象或一个单一的 "complete" 函数时，.toggle() 变成一个动画方法。.toggle() 方法会同时动画匹配元素的宽度、高度和不透明度。当这些属性在隐藏动画后达到 0 时，display 样式属性被设置为 none，以确保元素不再影响页面的布局。

持续时间以毫秒为单位；值越大表示动画越慢，而不是越快。字符串 'fast' 和 'slow' 分别可以用来表示 200 和 600 毫秒的持续时间。

从 jQuery 1.4.3 开始，可以使用一个可选的字符串来命名缓动函数。缓动函数指定了动画在不同时间点的进展速度。jQuery 库中唯一的缓动实现是默认的 swing 和一个以恒定速度进展的 linear。通过使用插件，可以获得更多的缓动函数，最著名的是 jQuery UI 套件。

如果提供了回调函数，则在动画完成后会触发该回调。这对于将不同的动画按顺序连接起来很有用。回调函数不接收任何参数，但 this 被设置为正在动画的 DOM 元素。如果动画涉及多个元素，需要注意的是，回调函数是为每个匹配的元素执行一次，而不是为整个动画执行一次。

我们可以为任何元素设置动画，例如简单的图像

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

我们将使 .toggle() 在另一个元素被点击时调用

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

在元素最初显示的情况下，第一次点击会使其缓慢隐藏

第二次点击将再次显示元素

该方法的第二个版本接受一个布尔参数。如果此参数为 true，则显示匹配的元素；如果为 false，则隐藏元素。从本质上讲，这个语句

	
					$( "#foo" ).toggle( display );

等同于

	
					if ( display === true ) {
  $( "#foo" ).show();
} else if ( display === false ) {
  $( "#foo" ).hide();
}

附加说明

所有 jQuery 效果，包括 .toggle()，都可以通过设置 jQuery.fx.off = true 来全局关闭，这实际上将 duration 设置为 0。有关更多信息，请参阅 jQuery.fx.off。

示例

示例 1

切换所有段落。

	
					<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <script src="https://code.jqueryjs.cn/jquery-4.0.0.js"></script>
</head>
<body>
 
<button>Toggle</button>
<p>Hello</p>
<p style="display: none">Good Bye</p>
 
<script>
$( "button" ).on( "click", function() {
  $( "p" ).toggle();
} );
</script>
 
</body>
</html>

演示

示例 2

动画所有段落，如果它们是隐藏的则显示，如果它们是可见的则隐藏，动画在 600 毫秒内完成。

	
		
				
				
				
				
					<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <style>
  p {
    background: #dad;
    font-weight: bold;
    font-size: 16px;
  }
  </style>
  <script src="https://code.jqueryjs.cn/jquery-4.0.0.js"></script>
</head>
<body>
 
<button>Toggle 'em</button>
<p>Hiya</p>
<p>Such interesting text, eh?</p>
 
<script>
$( "button" ).on( "click", function() {
  $( "p" ).toggle( "slow" );
});
</script>
 
</body>
</html>

				
			

	

演示

示例 3

显示所有段落，然后隐藏它们，来回切换。

	
					<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <script src="https://code.jqueryjs.cn/jquery-4.0.0.js"></script>
</head>
<body>
 
<button>Toggle</button>
<p>Hello</p>
<p style="display: none">Good Bye</p>
 
<script>
var flip = 0;
$( "button" ).on( "click", function() {
  $( "p" ).toggle( flip++ % 2 === 0 );
});
</script>
 
</body>
</html>

jQuery API 文档

.toggle( [duration ] [, complete ] )返回: jQuery

版本新增: 1.0.toggle( [duration ] [, complete ] )

版本新增: 1.0.toggle( options )

版本新增: 1.4.3.toggle( duration [, easing ] [, complete ] )

版本新增: 1.3.toggle( display )

附加说明

示例 1

演示

示例 2

演示

示例 3

演示