简记 jQuery 插件模板

/**
 * @lisence jquery plugin demo v1.0.0
 *
 * author: Jeremy Yu
 *
 * description: 
 *   this is a jquery plugin Template
 *   see the end of this document to learn how to use the jquery plugin
 */
;
(function($, window, document, undefined) {

    /* 插件类定义 */
    var PluginName = function(el, options) {
        this.version = "1.0.0"
        this.el = el;
        this.options = options;
        this.init(); //调用初始化方法
    }

    /* 定义无参方法,方法名为 init */
    PluginName.prototype.init = function() {
        /*  初始化操作 */
        alert('初始化成功');
    }

    /* 定义有参方法,方法名为 func */
    PluginName.prototype.func = function(arg) {
        /* TODO  */
    }

    /* 定义有返回值方法,方法名为 funcRet */
    PluginName.prototype.funcRet = function() {
        /* TODO 
         * 执行完后返回结果
         * 返回值可以是undefined、null、数字、字符串、布尔值、对象等
         * 如果没有返回，默认返回 undefined
         */
        return 0;
    }

    /* 定义命名空间，且作为data的key */
    var namespace = 'plugin_name';
    /* 定义插件 */
    $.fn.plugin_name = function(options) {
        var $this = $(this);
        var value, args = Array.prototype.slice.call(arguments, 1);
        var data = $this.data(namespace);
        if (!data) {
            var settings = $.extend({}, $.fn.plugin_name.defaults, options);
            $this.data(namespace, data = new PluginName(this, settings));
        }
        if (typeof options == 'string') {
            value = data[options].apply(data, args);
        }
        return typeof value === 'undefined' ? this : value;
    };

    /* 定义插件的默认值(属性、事件) */
    $.fn.plugin_name.defaults = {
        prop1: "",
        prop2: "",
        onEvent: function(arg1, arg2) {},
        onError: function(err) {}
    };


    /*
        引入 jquery.min.js 和 当前 js 文件

        HTML代码：
        <div id="#plugin"></div>

        插件使用
        $('#plugin').plugin_name({ prop1 : '', onEvent : function(){}});

        方法调用
        $('#plugin').plugin_name('function_name', args);
    */

})(jQuery, window, document);