.toggle()

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

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

  • 增补版本: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以来,队列选择也可以接受一个字符串,它导致动画可以添加到用字符串表示的队列中。如果队列名所用的动画还没有自动开始,你必须调用.dequeue("queuename")来启动它。
      • specialEasing
        类型:PlainObject
        一个对象,包含了一个或多个CSS属性,则属性参数和它们对应的渐进函数定义。 (增补版本:1.4)
      • step
        类型:Function( Number now, 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 )
        当动画在一个元素上完成时要调用的函数(它的应答对象已被解决)。 (增补版本:1.8)
      • fail
        类型:Function( Promise animation, Boolean jumpedToEnd )
        当某个元素上的动画失败而完成了的时候(它的应答对象被拒绝了)要调用的函数。 (增补版本:1.8)
      • always
        类型:Function( Promise animation, Boolean jumpedToEnd )
        当某对象上的动画完成,或未完成就停止了的时候(它的应答对象要么被解决了要么被拒绝了)要调用的函数。 (增补版本: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()方法仅仅是切换元素的可见性:

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

匹配的元素将被立即展现或隐藏,不带动画,只是改变CSS的display属性。如果元素原来是显示的,它将被隐藏;如果它原来是死期的,它将被展现。保存了display属性,以根据需要重载。如果某元素具有display值为inline,然后被隐藏,然后再被展现,它将再次显示为inline

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

duration是用毫秒数给出;更高的值指示更慢的动画,并非更快的动画。字符串'fast''slow'分别用来指示持续时间200毫秒和600毫秒。

自从jQuery 1.4.3以来,可以使用任何可选的字符串命名一个渐进函数。渐进函数指定了动画内部,在动画进程的不同点上的速率。jQuery库中仅有的渐进实现器是默认值,称为swing,以及以不变的速率前进的渐进实现器,称为linear。更多的渐进函数可以通过插件来实现,请注意jQuery UI套件

如果提供了回调函数,它会在动画结束时引发一次。这可以用来把不同的动画串列在一个顺序中。回调函数不能发送任何参数,但是this被设置为被变动的DOM元素。如变动了多个元素,请注意回调函数是对每个匹配的元素执行一次,而不是针对整个动画执行一次。

我们可以变动任意元素,譬如变动一个图像:

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

当另一个元素被点击时,将导致导致调用.toggle()

1
2
3
4
5
$( "#clickme" ).click(function() {
$( "#book" ).toggle( "slow", function() {
// Animation complete.
});
});

元素最初是显示的,第一次点击它就可以慢慢隐藏它:

插图 1 - 在隐藏图像时toggle()效果的演示

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

插图 2 - 在显示图像时toggle()效果的演示

方法的第二个版本接受一个Boolean参数。如果此参数是true,则显示匹配的元素;如果此参数是false,则隐藏匹配的元素。简言之,语句:

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

等同于:

1
2
3
4
5
if ( display === true ) {
$( "#foo" ).show();
} else if ( display === false ) {
$( "#foo" ).hide();
}

补充说明:

  • 所有jQuery效果,包括.toggle(),可以通过设置jQuery.fx.off = true,来全局地关闭。欲进一步了解,请参阅jQuery.fx.off

示例:

切换所有段落。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<!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毫秒内完成动画。

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
<!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>

演示:

显示所有段落,然后全部隐藏它们,如此反复。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<!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>

演示: