如何扩展 Twitter Bootstrap 插件

Question

我正在深入研究 Twitter 的 Bootstrap，现在想尝试向插件添加一些功能，但我不知道该怎么做。使用模态插件作为示例（http://twitter.github.com/bootstrap/javascript.html#modals< /a>)，我想向插件添加一个新函数，可以像标准插件方法一样调用它。我认为最接近的是下面的代码，但是当我尝试访问时，我得到的只是该函数不是对象的一部分。

有什么建议吗？这是我尝试过的，这似乎是最接近我需要做的：

 $.extend($.fn.modal, { 
    showFooterMessage: function (message) { 
        alert("Hey"); 
    } 
}); 

然后我想按如下方式调用它：

  $(this).closest(".modal").modal("showFooterMessage"); 

编辑：好的，我想出了如何做到这一点：

(function ($) {
    var extensionMethods = {
        displayFooterMessage: function ($msg) {
            var args = arguments[0]
            var that = this;

            // do stuff here
        }
    }

    $.extend(true, $.fn.modal.Constructor.prototype, extensionMethods);
})(jQuery);

现有的 Bootstrap 插件集的问题问题是，如果有人想扩展它们，则所有新方法都不能接受参数。我尝试“修复”这个问题是在插件函数调用中添加对参数的接受。

$.fn.modal = function (option) {
    var args = arguments[1] || {};
    return this.each(function () {
        var $this = $(this)
        , data = $this.data('modal')
        , options = typeof option == 'object' && option

        if (!data) $this.data('modal', (data = new Modal(this, options)))

        if (typeof option == 'string') data[option](args)
        else data.show()

    }) // end each
} // end $.fn.modal

Answer 1

这是一个旧线程，但我只是使用以下模式对模态进行了一些自定义扩展：

// save the original function object
var _super = $.fn.modal;

// add custom defaults
$.extend( _super.defaults, {
    foo: 'bar',
    john: 'doe'
});

// create a new constructor
var Modal = function(element, options) {

    // do custom constructor stuff here

     // call the original constructor
    _super.Constructor.apply( this, arguments );

}

// extend prototypes and add a super function
Modal.prototype = $.extend({}, _super.Constructor.prototype, {
    constructor: Modal,
    _super: function() {
        var args = $.makeArray(arguments);
        _super.Constructor.prototype[args.shift()].apply(this, args);
    },
    show: function() {

        // do custom method stuff

        // call the original method
        this._super('show');
    }
});

// override the old initialization with the new constructor
$.fn.modal = $.extend(function(option) {

    var args = $.makeArray(arguments),
        option = args.shift();

    return this.each(function() {

        var $this = $(this);
        var data = $this.data('modal'),
            options = $.extend({}, _super.defaults, $this.data(), typeof option == 'object' && option);

        if ( !data ) {
            $this.data('modal', (data = new Modal(this, options)));
        }
        if (typeof option == 'string') {
            data[option].apply( data, args );
        }
        else if ( options.show ) {
            data.show.apply( data, args );
        }
    });

}, $.fn.modal);

这样您可以

1) 添加自己的默认选项

2) 使用自定义参数创建新方法并访问原始（超级）函数

3) do在调用原始构造函数之前和/或之后构造函数中的内容

Answer 2

郑重声明，有一个简单的方法可以覆盖或扩展现有函数：

var _show = $.fn.modal.Constructor.prototype.show;

$.fn.modal.Constructor.prototype.show = function() {
    _show.apply(this, arguments);
    //Do custom stuff here
};

不涵盖自定义参数，但使用上面的方法也很容易；不要使用 apply 和 arguments，而是在函数定义中指定原始参数和自定义参数，然后调用原始 _show（或任何一个）是）使用原始参数，最后使用新参数做其他事情。

Answer 3

作为参考，我遇到了类似的问题，因此我通过分叉和“扩展”了 Typeahead 插件在插件脚本本身中添加我需要的功能。

如果您必须更改源代码，那么它实际上并不是一个扩展，因此我认为将所有修改放在一个地方会更容易。

Answer 4

对于任何希望使用 Bootstrap 3 执行此操作的人。插件布局已发生一些更改，所有 Bootstrap 3 插件的默认选项都附加到插件构造函数中：

var _super = $.fn.modal;
$.extend(_super.Constructor.DEFAULTS, {
       foo: 'bar',
       john: 'doe'
});

Answer 5

+1 以上来自大卫接受的答案。但如果我可以进一步简化它，我会调整 DEFAULTS 扩展和 $fn.modal 扩展，如下所示：

!function($) {

    'use strict';

    // save the original function object
    var _super = $.fn.modal;

    // create a new constructor
    var Modal = function(element, options) {

        // do custom constructor stuff here

        // call the original constructor
        _super.Constructor.apply( this, arguments );

    }

    // add custom defaults
    Modal.DEFAULTS = $.extend( _super.defaults, {
         myCustomOption: true
    });

    // extend prototypes and add a super function
    Modal.prototype = $.extend({}, _super.Constructor.prototype, {
        constructor: Modal,
        _super: function() {
            var args = $.makeArray(arguments);
            _super.Constructor.prototype[args.shift()].apply(this, args);
        },
        show: function() {

            // do custom method stuff

            // call the original method
            this._super('show');
        },
        myCustomMethod: function() {
            alert('new feature!');
        }
    });

    // Copied exactly from Bootstrap 3 (as of Modal.VERSION  = '3.3.5')
    // Notice: You can copy & paste it exactly, no differences!
    function Plugin(option, _relatedTarget) {
        return this.each(function () {
            var $this   = $(this)
            var data    = $this.data('bs.modal')
            var options = $.extend({}, Modal.DEFAULTS, $this.data(), typeof option == 'object' && option)

            if (!data) $this.data('bs.modal', (data = new Modal(this, options)))
            if (typeof option == 'string') data[option](_relatedTarget)
            else if (options.show) data.show(_relatedTarget)
        })
    }

    // override the old initialization with the new constructor
    $.fn.modal = $.extend(Plugin, $.fn.modal);

}(jQuery);