《锋利的jQuery》笔记:插件的使用和写法
jQuery插件的种类
1、封装对象方法
这种插件是将对象方法封装起来,用于对通过选择器获取的jQuery对象进行操作,是最常见的一种插件。此类插件可以发挥出jQuery选择器的强大优势,有相当一部分的jQuery的方法,都是在jQuery脚本库内部通过这种形式“插”在内核上的,例如parent()方法,appendTo()方法等。
2、封装全局函数
可以将独立的函数加到jQuery命名空间下。如常用的jQuery.ajax()方法、去首尾空格的jQuery.trim()方法,都是jQuery内部作为全局函数的插件附加到内核上去的。
3、选择器插件
虽然jQuery的选择器十分强大,但在少数情况下,还是会需要用到选择器插件来扩充一些自己喜欢的选择器。
jQuery插件的机制
jQuery插件的机制很简单,就是利用jQuery提供的jQuery.fn.extend()和jQuery.extend()方法,扩展jQuery的功能。
jQuery.fn.extend()多用于扩展上面提到的3种类型中的第一种,jQuery.extend()用于扩展后两种插件。这两个方法都接受一个参数,类型为Object。Object对象的“名/值对”分别代表“函数或方法名/函数主体”。
编写jQuery插件的一些Tips
1、jQuery插件的文件名推荐命名为jquery.[插件名].js,以免和其他JS库插件混淆。
2、所有的对象方法都应当附加到jQuery.fn对象上,而所有的全局函数都应当附加到jQuery对象本身。
3、在插件头部加上一个分号,以免他人的不规范代码给插件带来影响。
4、所有的方法或函数插件,都应当以分号结尾,以免压缩时出现问题
5、除非插件需要返回的是一些需要获取的变量,插件应该返回一个jQuery对象,以保证插件的可链式操作。
6、利于jQuery.extend()方法设置插件方法的默认参数,增加插件的可用性。
jQuery插件结构
jQuery插件结构如下:
;(function($){ /*这里放插件代码,可以将$作为jQuery的别名*/ })(jQuery);
封装jQuery对象方法插件实战
案例一:
功能:设置选择的元素的颜色,获取选择的首个元素的颜色
命名:jquery.color.js
;(function($){ $.fn.extend({ //这里写插件代码 }); })(jQuery);
思路:设置一个参数value,如果调用时传递了value这个参数,就是设置颜色,否则为获取颜色。获取和设置颜色可以用jQuery提供的css方法即可
;(function($){ $.fn.extend({ "color":function(value){ if(value==undefined){ return this.css("color"); } else{ return this.css("color",value); } } }); })(jQuery);
由于css()方法在获取颜色时已有取第一个元素的判断,所以这里直接用this.css("color")即可。
如果是一组插件,可以用如下写法:
;(function($){ $.fn.extend({ "color":function(value){ //插件代码 }, "border":function(value){ //插件代码 }, "background":function(value){ //插件代码 } }); })(jQuery);
案例二:表格隔行变色插件编写
;(function($) { $.fn.extend({ "alterBgColor":function(options){ //设置默认值 option=$.extend({ odd:"odd", even:"even", selected:"selected" },options); //注意这个options 同上面的function(options)中的option是同一个对象 //隔行变色 $("tbody>tr:even",this).addClass(option.even); $("tbody>tr:odd",this).addClass(option.odd); //单击行变色 $('tbody>tr',this).click(function(){ var hasSelected = $(this).hasClass(option.selected); $(this)[hasSelected?"removeClass":"addClass"](option.selected) .find(":checkbox").attr('checked',!hasSelected); }); $("tbody>tr:has(:checked)",this).addClass(option.selected); return this; //返回this,使方法可链 } }); })(jQuery);
$("#table2").alterBgColor().find("th").css("font-size","18");
封装全局函数插件实战
功能:单独去除左侧或单独去除右侧的空格
命名:jquery.lrtrim.js
结构:
;(function($){ $.extend({ ltrim:function(text){ //插件代码 }, rtrim:function(text){ //插件代码 } }); })(jQuery);
思路:这类插件是在jQuery命名空间内部添加一个函数,直接用正则表达式即可。
完整代码:
;(function($){ $.extend({ ltrim:function(text){ return (text||"").replace(/^\s+/g,""); }, rtrim:function(text){ return (text||"").replace(/\s+$/g,""); } }); })(jQuery);
自定义选择器插件实战
jQuery以其强大的选择器著称,那么jQuery的选择器的工作原理是什么呢?
jQuery的选择解析器首先会使用一组正则表达式来解析选择器,然后针对解析出的每一个选择符执行一个函数,称为选择函数。最后根据这个选择函数的返回值为true还是false来决定是否保留这个元素,这样就可以找到匹配的元素节点。
如$("div:gt(1)"),该选择器首先会获取所有的<div>元素,然后隐式地遍历这些<div>元素,并逐个将这些<div>元素作为参数,连同括号里的“1”等一些参数一起传递给gt对应的选择器函数进行判断。如果返回true则保留,否则不保留,这样得到的结果就是一个符合要求的<div>元素的集合。
:gt()选择器在jQuery源文件中的代码如下:
gt:function(a,i,m){ return i > m[3]-0; }
其中选择器的函数一共接受3个参数,形式如下:
function (a,i,m){ //... }
第一个参数为a,指的是当前遍历到的DOM元素。
第二个参数为i,指的是当前遍历到的DOM元素的索引值,从0开始。
第三个参数是m,它是由jQuery正则解析引擎进一步解析后的产物(用match匹配出来的),是一个数组。
- m[0],以上面的$("div:gt(1)")这个例子来讲,是:gt(1)这部分。它是jQuery选择器进一步将要匹配的内容。
- m[1],这里是选择器的引导符,匹配例子中的“:”,即冒号。并非只能使用“:”后面跟上选择器,用户还可以自定义其它的选择器引导符。
- m[2],即例子中的gt,确定究竟是调用哪个选择器函数。
- m[3],即例子中括号里的数字“1”,它非常有用,是编写选择器函数最重要的一个参数(m[3],在$("div:gl(1)")中即为括号里的数字“1”)。
- m[4],上面的例子中没有体现出来,这个比较罕见。例如“div:l(ss(dd))”这样一个选择器中,m[4]就指向了(dd)这部分,主要是带括号的(dd),而不只是dd。同时要注意,此时的m[3]的值是ss(dd)而非ss。
在jQuery中已经有lt,gt和eq选择器,因此这里写一个介于两者之间(between)的选择器,例如使用$("div:between(2,5)")能实现获取索引值为3、4元素的功能。
功能:选择索引值为a到b之间(a<b,a、b为正整数)的元素
命名:jquery.between.js
结构:
;(function($){ $.extend($.expr[":"],{ between:function(a,i,m){ //插件代码 } }); })(jQuery);
思路:在上面的三个参数中,m[3]为"a,b"的形式,因此把m[3]用","分隔,然后跟索引值i进行对比,如果i在m[3]表示的范围之间就返回true,否则为false
完整代码:
;(function($){ $.extend($.expr[":"],{ between:function(a,i,m){ var temp=m[3].split(","); return temp[0]-0<i&&i<temp[1]-0; } }); })(jQuery);
注:这里用temp[0]-0、temp[1]-0把字符串形式的数字转换成了数字。
另外一个实现方式,如下例子:
<div id="con1">1</div> <div id="con2">2</div> <div id="con3">3</div> <script type="text/javascript"> $(function(){ $("#con1").add("#con3").data("key","10001"); //定义一个新选择器 $.expr[ ":" ]['newselector'] = function(elem) { return !!$.data( elem, 'key' ); }; $("div:newselector").each(function(index,val){ console.log(this.id); //con1,con3 }) }); </script>
可参考地址:《什么?你还不会写JQuery 插件》