如何向这个jQuery插件模式添加一个方法？

Question

我正在为一个项目开发插件，以下代码是我基于《Smashing Magazine》上的一篇文章中的“A Lightweight Start”部分编写的： http://coding.smashingmagazine.com/2011/10/11/essential-jquery-plugin-patterns/。目前它已经完全符合我的需求，但是该文章的其余部分离题了并讨论了jQuery UI小部件，我认为我需要使用jQuery UI库，但我不想使用。请注意，html标签应保留。

/*!
 * jQuery lightweight plugin boilerplate
 * Original author: @ajpiano
 * Further changes, comments: @addyosmani
 * Licensed under the MIT license
 */

// the semi-colon before the function invocation is a safety
// net against concatenated scripts and/or other plugins
// that are not closed properly.
;(function ( $, window, document, undefined ) {

    // undefined is used here as the undefined global
    // variable in ECMAScript 3 and is mutable (i.e. it can
    // be changed by someone else). undefined isn't really
    // being passed in so we can ensure that its value is
    // truly undefined. In ES5, undefined can no longer be
    // modified.

    // window and document are passed through as local
    // variables rather than as globals, because this (slightly)
    // quickens the resolution process and can be more
    // efficiently minified (especially when both are
    // regularly referenced in your plugin).

    // Create the defaults once
    var pluginName = 'defaultPluginName',
        defaults = {
            propertyName: "value"
        };

    // The actual plugin constructor
    function Plugin( element, options ) {
        this.element = element;

        // jQuery has an extend method that merges the
        // contents of two or more objects, storing the
        // result in the first object. The first object
        // is generally empty because we don't want to alter
        // the default options for future instances of the plugin
        this.options = $.extend( {}, defaults, options) ;

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

        this.init();
    }

    Plugin.prototype.init = function () {
        // Place initialization logic here
        // You already have access to the DOM element and
        // the options via the instance, e.g. this.element
        // and this.options
    };

    // A really lightweight plugin wrapper around the constructor,
    // preventing against multiple instantiations
    $.fn[pluginName] = function ( options ) {
        return this.each(function () {
            if (!$.data(this, 'plugin_' + pluginName)) {
                $.data(this, 'plugin_' + pluginName,
                new Plugin( this, options ));
            }
        });
    }

})( jQuery, window, document );

我现在需要给这个插件添加一个方法，但是我不太清楚该如何操作。

该方法需要以这样的方式工作：通过控制台调用方法并传递一个值，就能动态地改变插件在页面上创建实例的属性（最终这将通过其他过程来完成，但目前使用控制台）。

我应该如何修改上面的代码以实现这一点呢？还是我的方向错了呢？

非常感谢任何帮助，复杂的JavaScript有时会让我感到困惑，但我喜欢尝试以“最佳实践”来完成任务。

- Rich C

Answer 1

jQuery文档强烈建议通过向主插件方法传递字符串来调用插件方法。这是为了防止您的插件方法使$.fn命名空间变得混乱不堪。因此，您可以这样做：

$.fn.yourPlugin = function(options) {
    if (typeof options === "string") {
        //Call method referred to by 'options'
    } else {
        //Setup plugin as usual
    }
};

在你的模式中，你已经有了定义方法的完美位置：Plugin.prototype。例如，要添加一个changeColor方法：

Plugin.prototype.changeColor = function(color) {
    $(this.element).css("color", color);
}

注意使用了$(this.element)。这是因为在Plugin构造函数中，定义了一个element属性，并将应用插件的元素分配给它：

this.element = element;

那是实际的DOM元素，而不是jQuery对象，因此需要对其调用jQuery。

现在你有了一个方法，需要添加一种机制来调用它。按照jQuery文档的建议：

$.fn[pluginName] = function ( options ) {
    return this.each(function () {
        if (typeof options === "string") {
            var args = Array.prototype.slice.call(arguments, 1),
                plugin = $.data(this, 'plugin_' + pluginName);
            plugin[options].apply(plugin, args);
        } else if (!$.data(this, 'plugin_' + pluginName)) {
            $.data(this, 'plugin_' + pluginName,
            new Plugin( this, options ));
        }
    });
};

您可以像这样调用changeColor方法：

$("#example").defaultPluginName("changeColour", "red");​​​​​​​​​​​​​​​​​​​​​​​​​​​

这里有一个带有工作示例的fiddle。您可能想要在调用方法的代码周围添加一些检查，以确保插件已经实例化到您正在调用的元素上。

- James Allardice

---

这看起来很不错，詹姆斯。我现在会试一下并回复你，但看起来非常有前途。谢谢。 - Rich C

Answer 2

与其从一个难以理解的样板开始，最好的方法是从起源开始：

http://docs.jquery.com/Plugins/Authoring

- Ja͢ck

Answer 3

使用

Plugin.prototype.reset = function () {

};
Plugin.prototype.destroy = function () {

};

等等。您可以添加任意多个选项。

- Zahid Riaz