jQuery 插件典型开发模式

jQuery 插件通常分两类。

  1. 基于选择器的插件(支持链式操作)
  2. 不基于选择器的插件(不支持链式操作)

前段时间简单学习了 jQuery 插件开发,开发了两个简单的插件,在此对两种插件的开发模式做简要总结。

基于选择器的插件

通常开发模式如下:

(function($, window, undefined) {
	$.fn.PluginName = function(opts) {
		var defaults = {
			// 插件自定义选项的默认值
		};

		// 以用户的自定义选项覆盖默认选项
		var options = $.extend(defaults, opts || {});

		return this.each(function() { // 让插件支持链式操作
			// 在这里编写插件功能代码
		});
	};
})(jQuery, window);

首先,创建一个匿名的自执行函数,形参为 $windowundefined,实参为 jQuerywindow

嗯?为什么没有为 undefined 对应地传入一个实参呢?这是一个小技巧,考虑到 undefined 这个变量名可能在其它地方的 JavaScript 代码赋过值,失去了它真正的意义,所以这里干脆不传入这个参数,以确保它在那个匿名自执行函数中是真正的 undefined

jQuery 传入后对应为 $,这样可以保证插件内调用的 $ 一定是 jQuery 而非 Prototype 之类的库。

此类插件的调用方式一般为 $(selector).PluginName(); 这种形式。

此类具体示例可参考 https://github.com/libuchao/KTwitter

不基于选择器的插件

由于此类插件不依赖于选择器,所以也无链式操作一说。一般开发模式如下:

(function($, window, undefined) {
	$.PluginName = function(opts) {
		var defaults = {
			// 插件自定义选项的默认值
		};

		// 以用户的自定义选项覆盖默认选项
		var options = $.extend(defaults, opts || {});

		// 在这里编写插件功能代码
	};
})(jQuery, window);

此类插件的调用形式一般为 $(selector).PluginName(); 这种形式。

此类插件具体示例可参考 https://github.com/libuchao/KBox

Posted on 2012-05-17

2 Comments

  • wsp wsp over 5 years ago

    $.expend() ?

  • lichao lichao over 5 years ago

    @wsp Should be $.extend()

Leave a Comment