jQuery.toggleClass() 函数详解

内容目录

toggleClass()函数用于切换当前jQuery对象所匹配的每个元素上指定的css类名。

所谓"切换"，就是若是该元素上已存在指定的类名，则移除掉；若是不存在，则添加该类名。

该方法检查每一个元素中指定的类。若是不存在则添加类，若是已设置则删除之。这就是所谓的切换效果。

经过使用 "switch" 参数，可以规定只删除或只添加类。

该函数属于jQuery对象(实例)。

语法

toggleClass()函数的用法比较复杂，其主要有如下两种用法：

用法一：

// 参数类型( string )是 v 1.0的用法
// 参数类型( string, boolean )是 v 1.3新增用法
// 参数类型( function [, boolean] )是 v 1.4 新增用法
jQueryObject.toggleClass( classNames [, switch ] )

切换指定的css类名classNames。若是存在指定的类名，则移除该类名；若是存在，则添加该类名。

参数switch用于指定是只添加仍是只移除指定的css类名。

用法二：jQuery 1.4 新增该用法。

jQueryObject.toggleClass( [ switch ] )

只要该元素有css类名，或者switch参数为false，toggleClass()将移除该元素全部的css类名。不然(其余任何状况)，都会将元素的class属性重置为最近一次调用toggleClass()函数(必须是该用法)时的有效class属性值("有效"意即不为空)。若是没有有效的class属性值，则重置class属性为空字符串。

注意：toggleClass()会"切换"当前jQuery对象所匹配的每个元素上指定的css类名。

参数

参数	描述
classNames	String/Function类型指定的css类名，字符串能够经过空格分隔的方式来添加多个css类名。或者为返回css类名的函数。
switch	Boolean类型一个布尔值，用于指定是添加仍是移除css类名。true表示添加，false表示移除。

 

jQuery 1.4 新增支持：参数className能够为函数。toggleClass()将根据匹配的全部元素遍历执行该函数，函数中的this将指向对应的DOM元素。

toggleClass()还会为函数传入3个参数：第一个参数就是该元素在匹配元素中的索引，第二个参数就是该元素节点当前的class属性值，第三个参数就是调用toggleClass()时传入的switch参数。

函数的返回值就是该元素须要切换的css类名(也能够经过空格分隔表示多个css类名)。若是返回值为空白字符串或者undefined，toggleClass()将不会为当前元素切换任何css类名。

返回值

toggleClass()函数的返回值是jQuery类型，返回当前jQuery对象自己。

示例

如下是toggleClass()函数应用时的部分等价代码，你能够参考理解。

$element.toggleClass( className );
// 至关于
if( $element.hasClass( className ) ){
	$element.removeClass( className );
}else{
	$element.addClass( className );	
}
//上面的className均表示单个css类名，若是是空格分隔的多个css类名，则等价部分的代码是须要循环执行的

/* ********** 分割线 ********** */

$element.toggleClass( className, true );
//至关于
$element.addClass( className );	

/* ********** 分割线 ********** */

$element.toggleClass( className, false );
//至关于
$element.removeClass( className );

如下面这段HTML代码为例：

<div id="n1">
   <p id="n2" class="demo test">CodePlayer</p>
   <p id="n3" class="foo">专一于编程开发技术分享</p>
</div>

咱们编写以下jQuery代码：

// 如下注释中的"当前"均表示在该函数执行以前

var $n2 = $("#n2");
// 切换n2上的一个css类名(当前有"demo"，切换后无"demo")
$n2.toggleClass("demo");
document.writeln( $n2.attr("class") ); // test

//切换n2上的2个css类名(当前无"demo"有"test"，切换后则有"demo"无"test")
$n2.toggleClass("demo test");
document.writeln( $n2.attr("class") ); // demo

var $n3 = $("#n3");
// 为n3添加2个css类名(类名"foo"已存在，不会重复添加)
// 至关于 $n3.addClass("foo bar");
$n3.toggleClass("foo bar", true);
document.writeln( $n3.attr("class") ); // foo bar

// 移除全部的css类名(当前的class属性值为"foo bar"，有css类名，内部会先存档再移除)
$n3.toggleClass(false);
document.writeln( $n3.attr("class") ); // (空字符串)

// 恢复为上一次保存的class属性值(当前的class属性值为""，没有css类名，内部不会保存)
// 此时switch不为false，而且元素没有css类名，所以会恢复为以前保存的class属性值("foo bar")
$n3.toggleClass(true);
document.writeln( $n3.attr("class") ); // foo bar

// 移除n3上的一个css类名
// 至关于 $n3.removeClass("bar");
$n3.toggleClass("bar", false);
document.writeln( $n3.attr("class") ); // foo

// 移除全部的css类名(当前的class属性值为"foo"，有css类名，内部会先存档再移除)
// 因为当前有css类名，所以不管参数是true仍是false，都会移除所有的css类名 
$n3.toggleClass(true);
document.writeln( $n3.attr("class") ); // (空字符串)

// 恢复为上次保存的class属性值(当前的class属性值为""，没有css类名，内部不会保存)
//此时switch不为false，而且元素没有css类名，所以会恢复为以前保存的class属性值("foo")
$n3.toggleClass(true);
document.writeln( $n3.attr("class") ); // foo

// 当前有css类名，移除全部的css类名(当前的class属性值为"foo"，有css类名，内部会先存档再移除)
// 至关于 $n3.toggleClass(true);
$n3.toggleClass();
document.writeln( $n3.attr("class") ); // (空字符串)

// 当前无css类名，恢复为上次保存的class属性值(当前的class属性值为""，没有css类名，内部不会保存)
//此时switch不为false，而且元素没有css类名，所以会恢复为以前保存的class属性值("foo")
$n3.toggleClass();
document.writeln( $n3.attr("class") ); // foo

// 切换、强制添加操做针对print-index和printed两个类名
// 移除只针对print-index (index表示当前元素在匹配元素中的索引)
function callback(index, classNames, _switch){
	// 函数内部的this指向迭代的当前DOM元素
	if( _switch === false){
		return "print-" + index;
	}else{ // true 或 undefined
		return "print-" + index + " printed";
	}	
}

// 这里的true，就是传递给函数callback的第三个参数_switch的值
$("p").toggleClass( callback, true);

https://blog.csdn.net/weixin_37580235/article/details/80735126