jQuery.toggleClass() 函数详解

更新日期: 2019-09-07阅读: 2.1k标签: 函数

内容目录

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类名。


参数

参数描述
classNamesString/Function类型指定的css类名,字符串可以通过空格分隔的方式来添加多个css类名。或者为返回css类名的函数。
switchBoolean类型一个布尔值,用于指定是添加还是移除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://www.fly63.com/article/detial/6282

JavaScript 函数式编程

我理解的 JavaScript 函数式编程,都认为属于函数式编程的范畴,只要他们是以函数作为主要载体的。

Js函数式编程,给你的代码增加一点点函数式编程的特性

给你的代码增加一点点函数式编程的特性,最近我对函数式编程非常感兴趣。这个概念让我着迷:应用数学来增强抽象性和强制纯粹性,以避免副作用,并实现代码的良好可复用性。同时,函数式编程非常复杂。

让我们来创建一个JavaScript Wait函数

Async/await以及它底层promises的应用正在猛烈地冲击着JS的世界。在大多数客户端和JS服务端平台的支持下,回调编程已经成为过去的事情。当然,基于回调的编程很丑陋的。

JavaScript函数创建的细节

如果你曾经了解或编写过JavaScript,你可能已经注意到定义函数的方法有两种。即便是对编程语言有更多经验的人也很难理解这些差异。在这篇博客的第一部分,我们将深入探讨函数声明和函数表达式之间的差异。

编写小而美函数的艺术

随着软件应用的复杂度不断上升,为了确保应用稳定且易拓展,代码质量就变的越来越重要。不幸的是,包括我在内的几乎每个开发者在职业生涯中都会面对质量很差的代码。这些代码通常有以下特征:

javascript回调函数的理解和使用方法(callback)

在js开发中,程序代码是从上而下一条线执行的,但有时候我们需要等待一个操作结束后,再进行下一步操作,这个时候就需要用到回调函数。 在js中,函数也是对象,确切地说:函数是用Function()构造函数创建的Function对象。

js调用函数的几种方法_ES5/ES6的函数调用方式

这篇文章主要介绍ES5中函数的4种调用,在ES5中函数内容的this指向和调用方法有关。以及ES6中函数的调用,使用箭头函数,其中箭头函数的this是和定义时有关和调用无关。

JavaScript中函数的三种定义方法

函数的三种定义方法分别是:函数定义语句、函数直接量表达式和Function()构造函数的方法,下面依次介绍这几种方法具体怎么实现,在实际编程中,Function()构造函数很少用到,前两中定义方法使用比较普遍。

js在excel的编写_excel支持使用JavaScript自定义函数编写

微软 称excel就实现面向开发者的功能,也就是说我们不仅可以全新定义的公式,还可以重新定义excel的内置函数,现在Excel自定义函数增加了使用 JavaScript 编写的支持,下面就简单介绍下如何使用js来编写excel自定义函数。

js中的立即执行函数的写法,立即执行函数作用是什么?

这篇文章主要讲解:js立即执行函数是什么?js使用立即执行函数有什么作用呢?js立即执行函数的写法有哪些?

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!