JavaScript教程 - 编写jQuery插件 - 《廖雪峰 JavaScript Python Git 教程》

编写jQuery插件

给jQuery对象绑定一个新方法是通过扩展 $.fn 对象实现的。让我们来编写第一个扩展—— highlight1() ：

$.fn.highlight1 = function () {

// this已绑定为当前jQuery对象:

this.css('backgroundColor', '#fffceb').css('color', '#d85030');

return this;

}

注意到函数内部的 this 在调用时被绑定为jQuery对象，所以函数内部代码可以正常调用所有jQuery对象的方法。

对于如下的HTML结构：

<!— HTML结构 —>

<div id="test-highlight1">

什么是jQuery

jQuery是目前最流行的JavaScript库。

</div>

来测试一下 highlight1() 的效果：

'use strict';

$('#test-highlight1 span').highlight1();

细心的童鞋可能发现了，为什么最后要 return this; ？因为jQuery对象支持链式操作，我们自己写的扩展方法也要能继续链式下去：

$('span.hl').highlight1().slideDown();

不然，用户调用的时候，就不得不把上面的代码拆成两行。

但是这个版本并不完美。有的用户希望高亮的颜色能自己来指定，怎么办？

我们可以给方法加个参数，让用户自己把参数用对象传进去。于是我们有了第二个版本的 highlight2() ：

$.fn.highlight2 = function (options) {

// 要考虑到各种情况:

// options为undefined

// options只有部分key

var bgcolor = options && options.backgroundColor || '#fffceb';

var color = options && options.color || '#d85030';

this.css('backgroundColor', bgcolor).css('color', color);

return this;

}

对于如下HTML结构：

<!— HTML结构 —>

<div id="test-highlight2">

什么是jQuery Plugin

编写jQuery Plugin可以用来扩展jQuery的功能。

</div>

来实测一下带参数的 highlight2() ：

'use strict';

$('#test-highlight2 span').highlight2({

backgroundColor: '#00a8e6',

color: '#ffffff'

});

对于默认值的处理，我们用了一个简单的 && 和 || 短路操作符，总能得到一个有效的值。

另一种方法是使用jQuery提供的辅助方法 $.extend(target, obj1, obj2, …) ，它把多个object对象的属性合并到第一个target对象中，遇到同名属性，总是使用靠后的对象的值，也就是越往后优先级越高：

// 把默认值和用户传入的options合并到对象{}中并返回:

var opts = $.extend({}, {

backgroundColor: '#00a8e6',

color: '#ffffff'

}, options);

紧接着用户对 highlight2() 提出了意见：每次调用都需要传入自定义的设置，能不能让我自己设定一个缺省值，以后的调用统一使用无参数的 highlight2() ？

也就是说，我们设定的默认值应该能允许用户修改。

那默认值放哪比较合适？放全局变量肯定不合适，最佳地点是 $.fn.highlight2 这个函数对象本身。

于是最终版的 highlight() 终于诞生了：

$.fn.highlight = function (options) {

// 合并默认值和用户设定值:

var opts = $.extend({}, $.fn.highlight.defaults, options);

this.css('backgroundColor', opts.backgroundColor).css('color', opts.color);

return this;

}

// 设定默认值:

$.fn.highlight.defaults = {

color: '#d85030',

backgroundColor: '#fff8de'

}

这次用户终于满意了。用户使用时，只需一次性设定默认值：

$.fn.highlight.defaults.color = '#fff';

$.fn.highlight.defaults.backgroundColor = '#000';

然后就可以非常简单地调用 highlight() 了。

对如下的HTML结构：

<!— HTML结构 —>

<div id="test-highlight">

如何编写jQuery Plugin

编写jQuery Plugin，要设置默认值，并允许用户修改默认值，或者运行时传入其他值。

</div>

实测一下修改默认值的效果：

'use strict';

$.fn.highlight.defaults.color = '#659f13';

$.fn.highlight.defaults.backgroundColor = '#f2fae3';

$('#test-highlight p:first-child span').highlight();

$('#test-highlight p:last-child span').highlight({

color: '#dd1144'

});

最终，我们得出编写一个jQuery插件的原则：

给 $.fn 绑定函数，实现插件的代码逻辑；
插件函数最后要 return this; 以支持链式调用；
插件函数要有默认值，绑定在 $.fn.<pluginName>.defaults 上；
用户在调用时可传入设定值以便覆盖默认值。