我的jQuery插件是否有弱点(模式方面)?

时间:2010-12-17 04:10:14

标签: jquery jquery-plugins design-patterns

我在互联网上找到了一个插件模式。 (我会在找到它后立即提交链接)然后我修改了一下以创建我自己的对话框插件。我担心即使代码工作,我做的方式也没有意义。

我必须:

  • 能够将我的插件分配给 多元素(多一个元素 对话框) - 实现
  • 我必须能够访问它的方法 :openDialog,closeDialog, 从其外部的assignOptions 尚未实施
  • 我想发送一个参考 一个按钮时的当前对话框 点击发生 - 部分实施。 我正在使用$(this).getDialog() 方法。 this指的是点击的 按钮

这是插件:

(function($) {
    var pluginName = "Dialog",
        dialogContent = { "Title" : "h2", "SubTitle" : "p.sub-title", "Body" : "div.content" }

    var infDialog = function( el, options ) {
        var $el = $(el),
            currentConfig = {
                position : [100, 100],
                autoOpen : true
            };

        $el.data( pluginName, $el);

        if ( options ) {
            currentConfig = $.extend( currentConfig, options );
        }

        $el.css({ "top" : currentConfig.position[1], "left" : currentConfig.position[0], "z-index" : 9999 });

        if ( currentConfig.autoOpen ) {
            $el.fadeIn( "slow" );
        }

        if ( currentConfig.buttons ) {
            $.each(currentConfig.buttons, function(i, j) {
                if ( $.isFunction( j ) && $(el).find("input[value='" + i + "']").length )
                {
                    var $currentButton = $(el).find("input[value='" + i + "']");

                    $(el).find("input[value='" + i + "']").click(function() {
                        j.call( $currentButton );
                    });
                }
            });
        }

        if ( currentConfig.onOpen ) {
            currentConfig.onOpen.call( $el );
        }

        if ( currentConfig.onClose ) {
            $el.bind("onclose", function() {
                currentConfig.onClose.call( $el );
            });
        }

        $el.getDialog().bind("click", function( e ) {
            var currentDialog = this.id,
                currentPosition = $(this).css("z-index");

            if ( currentPosition < 9999 || currentPosition == "auto" ) {
                $(".dialog").each(function(i) {
                    if ( this.id == currentDialog ) {
                        $(this).css("z-index", 9999);
                    } else {
                        $(this).css("z-index", 9990);
                    }
                });

                $(this).css("z-index");
            }
        });
    }

    $.fn.infDialog = function( options ) {
        return this.each(function() {
            ( new infDialog( this, options ) );
        });
    }

    $.fn.closeDialog = function() {
        return $(this).getDialog().fadeOut("slow", function() {
            $(this).trigger("onclose");
        });
    }

    $.fn.getDialog = function() {
        return ( ! $(this).is(".dialog") ) ? $(this).closest(".dialog") : $(this);
    }

    $.fn.assignOption = function( options ) {
        var $currentPlugin = $(this);

        $.each( options, function(i, j) {
            if ( dialogContent[ i ] ) {
                $currentPlugin.find( dialogContent[ i ] ).empty().html( j );
            }
        });
    }
})(jQuery);

和对话框的HTML:

<div id="dialogTest" class="dialog">
    <div>
        <h2>title</h2>
        <p class="sub-title">
            subtitle
        </p>
        <div class="content">
            Content
        </div>
        <p class="buttons"><input type="button" value="Action" /> <input type="button" value="Close" class="normal" /></p>
    </div>
</div>

和jQuery代码:

$("#dialogTest").infDialog({
    position : [400, 190],
    buttons : {
        "Action" : function() {
            var $dialog = $(this).getDialog(),
                obj = $dialog.data("Dialog"),
                $currentDialog = $(this).getDialog();

            $currentDialog.assignOption({
                "Title" : "New Title",
                "SubTitle" : "Lorem ipsum",
                "Bob" : "unknown body tag",
                "Body" : "testbody"
            });

            $(this).attr("value", Math.random());
        },
        "Close" : function() {
            $(this).closeDialog();
        }
    },
    onOpen : function() {

    },
    onClose : function() {
        var $currentDialog = $(this).getDialog();

        $currentDialog.fadeIn("fast");
    }
});

我做错了什么,或者我实际上正朝着好的方向前进?

在旁注中,我发现设计模式建议的此代码:$ el.data( pluginName, $el);不起作用。实际上,每次我尝试使用$("#dialogTest").data("Dialog")检索对象时,返回的对象都是空的。

谢谢

2 个答案:

答案 0 :(得分:0)

为您提供几个快速提示:

  1. 在分配给jquery.fn(jQuery Prototype)的函数表达式中,this已经是一个jQuery对象。

    $.fn.method = function( options ) {
        return this.each(function() {
            //do something
        });
    }
    
  2. 一个插件在jquery.fn命名空间上使用4个方法名称通常不是一个好主意。使用jQuery UI Widget框架,您只能使用一个方法名称

    $.widget("cybrix.coolDialog", {
        ...
        close: function() { ... },
        open: function() { ... },
        assign: function() { ... }
    }
    

    然后

    $("#dialogTest").coolDialog('close');
    $("#dialogTest").coolDialog('open');
    $("#dialogTest").coolDialog('assign');
    

    你可以做这个或类似的东西而不依赖于jquery.ui.widget.js

  3. 对于大多数jQuery事件,on前缀不常见

答案 1 :(得分:0)

jQuery Plugin Authoring tutorial给了我使用的jQuery插件模式。

关于您的assignOptions任务......

如果你有一个私人设置对象并传递你的插件,那么它可以很好地工作(当然这在教程中有概述)。

扩展示例

(function( $ ){

  $.fn.tooltip = function( options ) {  
    //private settings
    var settings = {
      'location'         : 'top',
      'background-color' : 'blue'
    };
    // returning this.each ensures your plugin works on multiple matched elements
    return this.each(function() {        
      // If options exist, lets merge them
      // with our default settings
      if ( options ) { 
        $.extend( settings, options );
      }

      // Tooltip plugin code here

    });

  };
})( jQuery );
//initiate plugin with an options object
var options = { 'location' : 'left' };
$('div').tooltip( options );