我最喜歡的jQuery外掛模板

ourjs發表於2013-12-28

  我使用jQuery已經有相當長的時間了,並且我會常常為它寫一些外掛(plugin)。我嘗試過用不同的方式去寫,現在這個模板是我最喜歡的:

 

;(function($) {
  // multiple plugins can go here
  (function(pluginName) {
    var defaults = {
      color: 'black',
      testFor: function(div) {
        return true;
      }
    };
    $.fn[pluginName] = function(options) {
      options = $.extend(true, {}, defaults, options);
            
      return this.each(function() {
        var elem = this,
          $elem = $(elem);

        // heres the guts of the plugin
          if (options.testFor(elem)) {
            $elem.css({
              borderWidth: 1,
              borderStyle: 'solid',
              borderColor: options.color
            });
          }
      });
    };
    $.fn[pluginName].defaults = defaults;  
  })('borderize');
})(jQuery);

//下面是用法
$('div').borderize();
$('div').borderize({color: 'red'});

  以下是我喜歡這種模板的原因

  1. 你仍然可以訪問裡面的預設選項,即便它被重寫了(簡單地通過父屬性的訪問)

  2. 通過修改pluginName即可更改外掛的名字。(這種方式對程式碼壓縮也非常有利)

  第#1點非常強大,比如說我們希望複寫這個方法,但是仍然希望保留原來的方法,我們可以看下面的例子:

$('.borderize').borderize({
    testFor: function(elem) {
        var $elem = $(elem);
        if (elem.is('.inactive')) {
            return false;
        } else {
            // calling "parent" function
            return $.fn.borderize.defaults.testFor.apply(this, arguments);
        }
    }
});
We can even do this with regular properties like this

var someVarThatMayBeSet = false;
/* code ... */

$('.borderize').borderize({
    color: someVarThatMayBeSet ? 'red' : $.fn.borderize.defaults.color
});

  你有更好的模板嗎?歡迎回復。

  原文 kolodny.github.io

相關文章