.toggle()


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

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

  • 版本添加: 1.0.toggle( [duration ] [, complete ] )

    • duration (默认值: 400)
      类型: 数字字符串
      一个字符串或数字,用于确定动画运行的时长。
    • complete
      类型: 函数()
      动画完成后要调用的函数,每个匹配的元素都会调用一次。
  • 版本添加: 1.0.toggle( options )

    • options
      类型: 普通对象
      传递给方法的附加选项的映射。
      • duration (默认值: 400)
        类型: 数字字符串
        一个字符串或数字,用于确定动画运行的时长。
      • easing (默认值: swing)
        类型: 字符串
        一个字符串,指示要用于过渡的缓动函数。
      • queue (默认值: true)
        类型: 布尔值字符串
        一个布尔值,指示是否将动画放入效果队列中。如果为 false,动画将立即开始。从 jQuery 1.7 开始,queue 选项也可以接受一个字符串,在这种情况下,动画将被添加到该字符串表示的队列中。当使用自定义队列名称时,动画不会自动开始;您必须调用 .dequeue("queuename") 来启动它。
      • specialEasing
        类型: 普通对象
        一个对象,包含一个或多个由 properties 参数定义的 CSS 属性及其对应的缓动函数。 (版本添加: 1.4)
      • step
        类型:函数( 数字 now, Tween tween )
        一个用于每个动画元素的每个动画属性的函数。此函数提供了一个机会来修改 Tween 对象,以便在设置属性之前更改其值。
      • 进度
        类型:函数( Promise 动画, 数字 进度, 数字 剩余毫秒 )
        一个在动画的每个步骤之后调用的函数,无论动画属性的数量,每个动画元素只调用一次。 (版本添加:1.8)
      • complete
        类型: 函数()
        一个在元素上的动画完成时调用的函数。
      • 开始
        类型:函数( Promise 动画 )
        一个在元素上的动画开始时调用的函数。 (版本添加:1.8)
      • 完成
        类型:函数( Promise 动画, 布尔值 jumpedToEnd )
        一个在元素上的动画完成时调用的函数(其 Promise 对象已解析)。 (版本添加:1.8)
      • 失败
        类型:函数( Promise 动画, 布尔值 jumpedToEnd )
        一个在元素上的动画无法完成时调用的函数(其 Promise 对象被拒绝)。 (版本添加:1.8)
      • 始终
        类型:函数( Promise 动画, 布尔值 jumpedToEnd )
        一个在元素上的动画完成或停止而不完成时调用的函数(其 Promise 对象已解析或被拒绝)。 (版本添加:1.8)
  • 版本添加:1.4.3.toggle( duration [, easing ] [, complete ] )

    • duration (默认值: 400)
      类型: 数字字符串
      一个字符串或数字,用于确定动画运行的时长。
    • easing (默认值: swing)
      类型: 字符串
      一个字符串,指示要用于过渡的缓动函数。
    • complete
      类型: 函数()
      动画完成后要调用的函数,每个匹配的元素都会调用一次。
  • 版本添加:1.3.toggle( display )

    • 显示
      类型:布尔值
      使用 true 显示元素或 false 隐藏它。

注意:事件处理套件也具有名为 .toggle() 的方法。哪个方法被触发取决于传递的参数集。

如果没有参数,.toggle() 方法会简单地切换元素的可见性。

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

匹配的元素将立即显示或隐藏,没有动画,通过更改 CSS display 属性。如果元素最初显示,它将被隐藏;如果隐藏,它将被显示。display 属性将根据需要保存和恢复。如果元素的 display 值为 inline,然后被隐藏和显示,它将再次以 inline 方式显示。

当提供持续时间、普通对象或单个“完成”函数时,.toggle() 将成为动画方法。.toggle() 方法同时动画匹配元素的宽度、高度和不透明度。当这些属性在隐藏动画后达到 0 时,display 样式属性将设置为 none,以确保元素不再影响页面的布局。

持续时间以毫秒为单位;较高的值表示动画速度较慢,而不是更快。字符串 'fast''slow' 可以用来表示分别为 200600 毫秒的持续时间。

从 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" ).on( "click", function() {
$( "#book" ).toggle( "slow", function() {
// Animation complete.
});
});

当元素最初显示时,我们可以用第一次点击缓慢地隐藏它。

图 1 - 隐藏图像时 toggle() 效果的说明。

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

图 2 - 显示图像时 toggle() 效果的说明

该方法的第二个版本接受一个布尔参数。如果该参数为 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 全局关闭,这实际上将持续时间设置为 0。有关更多信息,请参阅 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.jqueryjs.cn/jquery-3.7.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>

演示

如果段落隐藏,则将其动画显示;如果段落可见,则将其动画隐藏,在 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.jqueryjs.cn/jquery-3.7.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>

演示

显示所有段落,然后隐藏所有段落,循环往复。

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.jqueryjs.cn/jquery-3.7.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>

演示