jQuery插件写法

最近在学写jQuery插件,记录一下写插件的方式。
jQuery为用户提供了jQuery.extend()jQuery.fn.extend()的方法。
jQuery.extend()方法将两个或多个对象的内容合并到第一个对象中。一般jQuery.extend()方法用来合并参数。
用法:<code>jQuery.extend(target [, object1 ] [, objectN ]);</code>
或<code>jQuery.extend([deep],target [, object1 ] [, objectN ]);</code>
如果deep为true,则递归合并,会进行深拷贝.
jQuery.extend(target [, object1 ] [, objectN ])示例:
<pre>
var person1 = {
name:'who',
age:18,
parents:{father: 'someone', mom: 'anybody'}
};
var person2= {
parents:{mom:'someone'},
sex:'boy'
};
$.extend(person1,person2);//person1={name:'who',age:18,parents:{mom:'someone'},sex:'boy'};
</pre>
jQuery.extend([deep],target [, object1 ] [, objectN ])示例:
<pre>
var person1 = {
name:'who',
age:18,
parents:{father: 'someone', mom: 'anybody'}
};
var person2= {
parents:{mom:'someone'},
sex:'boy'
};
$.extend(true,person1,person2);//person1={name:'who',age:18,parents:{father:'someone',mom:'someone'},sex:'boy'};
</pre>
一般在写插件时,不会覆盖掉默认参数defaults,所以在扩展参数时一个好的写法是$.extend({},defaults,options),用一个空对象{}作为第一个参数,这样能将所有值合并到{}中,并且保护好默认参数。
jQuery.fn.extend()方法将对象的内容合并到jQuery原型上以提供新的jQuery实例方法。该方法扩展jQuery prototype($.fn)对象以提供可以链接到该jQuery()函数的新方法。
插件一般有两种书写形式:
<pre>
//第一种
$.fn.functionName = function([options]){};//这个一次只能声明一个函数
//第二种
$.fn.extend({func1:function{},funcN:function{}});//这个可以声明多个函数
</pre>
可以这样写插件:
<pre>
$.fn.myPlugin = function(options){
var defaults={attr1:value1,attrN:valueN};//默认参数
var settings=$.extend({},defaults,options);//扩展参数
return this.each(function(){
//some operations use settings you want
});//加return返回jQuery对象本身,这样是为了能支持jQuery的链式调用
}
//调用方式
$(obj).myPlugin({prop1:value1,propN:valueN});
</pre>
或者这样:
<pre>
$.fn.extend({
func1:function(options){
//something like $.fn.functionName
},
func2:function(options){
//something like $.fn.functionName
}
});
//调用方式
$(obj).func1(options);
$(obj).func2(options);
</pre>
一种较好的写法是将代码写在一个自调用匿名函数里面,例如:
<pre>
;(function($,window,document,undefined){
//our code
})(jQuery,window,document);
</pre>
说明几点:

  1. 在最前面加分号;是为了防止别人在引用该插件时,别人在之前编写的代码结尾没有加;会导致该匿名函数与别人的代码相连,代码无法正常解析而报错。
  2. $实参接受jQuery对象;window, document实参分别接受window, document对象,window, document对象都是全局环境下的,而将window等系统变量以参数形式传递到插件内部时,这些变量在插件内部是一个局部的引用,这样可以减少作用域链的查询时间,提高访问速度。
  3. undefined形参可能是为了兼容性,实际上并没有传递这个参数。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容