jQuery插件创建和面向公众的方法

时间:2012-10-14 07:44:05

标签: jquery plugins methods public creation

我创建了一个插件,可以使用DIV将HTML选择框转换为自定义下拉列表。

一切运作良好,但我想让它好一点。 see my jsFiddle

在插件的最后我有2个方法,slideDownOptions& slideUpOptions,我想在插件之外使这些可用,以便其他事件可以触发操作。

我对如何执行此操作感到有些困惑,更具体地说,如何从插件内部和插件外部调用方法。

任何帮助总是赞赏

2 个答案:

答案 0 :(得分:13)

考虑使用面向对象的代码重构您的插件。有了这个,您可以为您的插件制作API,如jQuery UI API。因此,您可以访问插件方法,如:

$('select').customSelect(); // apply plugin to elements
$('select').customSelect('resetOpacity'); // call method resetOpacity();
$('select').customSelect('setOpacity', 0.5); // call method with arguments

创建此类插件的基本模板如下所示:

// plugin example
(function($){
    // custom select class
    function CustomSelect(item, options) {
        this.options = $.extend({
            foo: 'bar'
        }, options);
        this.item = $(item);
        this.init();
    }
    CustomSelect.prototype = {
        init: function() {
            this.item.css({opacity:0.5});
        },
        resetOpacity: function() {
            this.setOpacity('');
        },
        setOpacity: function(opacity) {
            this.item.css({opacity:opacity});
        }
    }

    // jQuery plugin interface
    $.fn.customSelect = function(opt) {
        // slice arguments to leave only arguments after function name
        var args = Array.prototype.slice.call(arguments, 1);
        return this.each(function() {
            var item = $(this), instance = item.data('CustomSelect');
            if(!instance) {
                // create plugin instance and save it in data
                item.data('CustomSelect', new CustomSelect(this, opt));
            } else {
                // if instance already created call method
                if(typeof opt === 'string') {
                    instance[opt].apply(instance, args);
                }
            }
        });
    }

}(jQuery));

// plugin testing
$('select').customSelect();

在这里工作JS小提琴:http://jsfiddle.net/XsZ3Z/

答案 1 :(得分:4)

您必须重构代码才能使其正常运行。考虑使用jQuery Boilerplate

;(function ( $, window, undefined ) {

  var pluginName = 'convertSelect',
  document = window.document,
  defaults = {
    propertyName: "value"
  };

  function Plugin( element, options ) {
    this.element = element;
    this.options = $.extend( {}, defaults, options) ;

    this._defaults = defaults;
    this._name = pluginName;

    this.init();
  }

  Plugin.prototype = {

    // Private methods start with underscore
    _generateMarkup: function() {

      // you can access 'this' which refers to the constructor
      // so you have access the all the properties an methods
      // of the prototype, for example:
      var o = this.options

    },

    // Public methods
    slideDownOptions: function() { ... }

  }

  $.fn[ pluginName ] = function ( options ) {
    return this.each(function () {
      if (!$.data( this, 'plugin_' + pluginName ) ) {
        $.data( this, 'plugin_' + pluginName, new Plugin( this, options ) );
      }
    });
  };

}(jQuery, window));

然后你可以像这样调用公共方法:

var $select = $('select').convertSelect().data('plugin_convertSelect');
$select.slideDownOptions();

我的一个项目有类似的问题,我最近不得不重构整个事情,因为我用太多的方法污染了jQuery命名空间。 jQuery Boilerplate工作得非常好,它基于官方的jQuery指南,但有一些曲折。如果您想看到这个插件模式,请查看https://github.com/elclanrs/jq-idealforms/tree/master/js/src