.toggle()| jqueryAPI 2.2 中文手册- AspRain.cn 致力于Web开发技术翻译整理

jQuery API 2.2.0

.toggle()

分类:效果 > 基本效果

返回: jQuery

.toggle( [duration ] [, complete ] )

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

加入于: 1.0
.toggle( [duration ] [, complete ] )
  • duration (默认值:400)
    类型:Number or String
    一个字符串或数字,用来确定动画运行多长时间。
  • complete
    类型:Function()
    一个函数,在动画一旦结束时调用它,对每个匹配的元素调用一次。
加入于: 1.0
.toggle( options )
  • options
    类型:PlainObject
    传递给该方法的一个额外选项的映射。
    • duration (默认值:400)
      类型:Number or String
      一个字符串或数字,用来确定动画运行多长时间。
    • easing (默认值:swing)
      类型:String
      一个字符串,标明为过渡使用哪种缓动函数。
    • queue (默认值:true)
      类型:Boolean or String
      一个布尔值,标明是否要把动画放到效果队列中。如果是false,动画将立即开始。自从jQuery 1.7,queue选项可以接受一个字符串,那样的话,动画将加到以那个字符串代表的队列中。如果使用了一个自定义队列名,动画不会自动开始;你必须调用.dequeue("queuename")来启动它。
    • specialEasing
      类型:PlainObject
      一个对象,包含了一个或更多的用属性参数和它们对应的缓动函数定义的CSS属性。(加入于1.4
    • step
      类型:FunctionNumber now, Tween tween )
      一个函数,每个变动的元素的每个变动的CSS属性都会调用它。这个函数提供了一个改变Tween对象的机会,可以在该属性被设置之前改变该属性的值。
    • progress
      类型:FunctionPromise animation, Number progress, Number remainingMs )
      一个函数,在每个动画阶结束时调用它,只对每个变动的元素调用一次,无论有多少个变动的属性。(加入于1.8
    • complete
      类型:Function()
      一个函数,在动画一旦结束时调用它。
    • start
      类型:FunctionPromise animation )
      一个函数,每个元素上的动画开始时都会调用它一次。(加入于1.8
    • done
      类型:FunctionPromise animation, Boolean jumpedToEnd )
      一个函数,每个元素上的动画结束时都会调用它一次(它的Promise对象被解决了)。(加入于1.8
    • fail
      类型:FunctionPromise animation, Boolean jumpedToEnd )
      一个函数,每个元素上的动画结束时都会调用它一次(它的Promise对象被拒绝了)。(加入于1.8
    • always
      类型:FunctionPromise animation, Boolean jumpedToEnd )
      一个函数,在某个元素上的动画,或者在没结束时停止的时候(该元素的Promise对象要么是被解决要么是被拒绝)调用它。(加入于1.8
加入于: 1.4.3
.toggle( duration [, easing ] [, complete ] )
  • duration (默认值:400)
    类型:Number or String
    一个字符串或数字,用来确定动画运行多长时间。
  • easing (默认值:swing)
    类型:String
    一个字符串,标明为过渡使用哪种缓动函数。
  • complete
    类型:Function()
    一个函数,在动画一旦结束时调用它,对每个匹配的元素调用一次。
加入于: 1.3
.toggle( display )
  • display
    类型:Boolean
    使用true显示元素,使用false隐藏元素。

注意:事件处理套装中也有一个名为.toggle()的方法。引发哪个函数,取决于传递给它的参数集合。

不带参数的使用.toggle()方法,仅仅是切换元素的可见性:

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

通过改变CSS属性display,匹配的元素会被快速显示或隐藏,不带动画。如果该元素本来是显示的,它会被隐藏;如果本来是隐藏的,它会被显示出来。CSS属性display会被保存起来,以备需要的时候可以恢复。如果一个元素具有CSS属性display:inline;,然后被隐藏并再度显示,它依然会显示为display:inline

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

持续时间用毫秒数指定;更大的数字表示更慢的动画,而不是更快的动画。字符串'fast'表示200毫秒的持续时间,'slow'表示800毫秒的持续时间。

自从jQuery 1.4.3,可以使用一个可选的字符串,它命名了一个缓动函数。缓动函数指定了在动画过程内不同的时点上动画推进的速度。在jQuery库内只有两个缓动实现器,一个是默认情况下,称为swing,另一个是以恒定的节奏推进,称为linear。更多的缓动函数要用插件才能使用,特别是使用jQuery UI suite插件。

如果提供了,一旦动画结束时,会引发回调函数。这可以用来将不同的动画串成一个事件序列。回调函数并不发送任何参数,但是this被设置为执行动画的DOM元素。如果变动了多个元素,需要注意:回调函数会在每个匹配的元素上各执行一次,不是针对整个动画执行一次。

我们可以变动任何元素,比如说一个图像:

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

我们可以做到当另一个元素被点击时,调用.toggle()

$( "#clickme" ).click(function() {
  $( "#book" ).toggle( "slow", function() {
    // 动画完成。
  });
});

先显示元素,在第一次点击时我们可以慢慢地隐藏它:

插图1

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

插图2

该方法的第二个版本接收一个布尔参数。如果参数值是true,匹配的元素会被显示出来,如果参数值是false,匹配的元素会被隐藏起来。从本质上讲,下面的语句:

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

相当于

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

其它说明

  • 所有的动画效果,包括.toggle()可以全局性地关闭,只要设置jQuery.fx.off=true,它会有效地把duration设置为0。要了解更多关于它的信息,参见jQuery.fx.off

示例

切换所有段落文本。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <script src="https://code.jquery.com/jquery-1.10.2.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>

演示结果

变动所有的段落文本,如果它们是隐藏的,就显示它们,如果它们是显示的,就隐藏它们,在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.jquery.com/jquery-1.10.2.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>

演示结果

显示所有的段落文本,然后全部隐藏它们,周而复始。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>toggle demo</title>
  <script src="https://code.jquery.com/jquery-1.10.2.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>

演示结果

如果网页上不能运行示例,请点击http://www.asprain.cn/jQueryAPI/toggle.htm查看示例。

如果你觉得本文档对你有用,欢迎给翻译作者支付宝打赏,支持翻译作者源源不断翻译更多有用的技术文档。