如何使用方法创建jQuery插件?


191

我正在尝试编写一个jQuery插件,它将为调用它的对象提供其他功能/方法。我在线阅读的所有教程(过去2个小时内一直在浏览)最多都包含如何添加选项,但不包含其他功能。

这是我想要做的:

//通过调用该div的插件将div格式化为消息容器

$("#mydiv").messagePlugin();
$("#mydiv").messagePlugin().saySomething("hello");

或类似的规定。归结为以下几点:调用插件,然后调用与该插件关联的函数。我似乎找不到找到这种方法的方法,而且我以前看过很多插件都这样做。

这是到目前为止我对插件的了解:

jQuery.fn.messagePlugin = function() {
  return this.each(function(){
    alert(this);
  });

  //i tried to do this, but it does not seem to work
  jQuery.fn.messagePlugin.saySomething = function(message){
    $(this).html(message);
  }
};

我该如何实现这样的目标?

谢谢!


更新2013年11月18日:我已更改对Hari以下评论和支持的正确答案。

Answers:


310

根据jQuery插件创作页面(http://docs.jquery.com/Plugins/Authoring),最好不要混淆jQuery和jQuery.fn命名空间。他们建议这种方法:

(function( $ ){

    var methods = {
        init : function(options) {

        },
        show : function( ) {    },// IS
        hide : function( ) {  },// GOOD
        update : function( content ) {  }// !!!
    };

    $.fn.tooltip = function(methodOrOptions) {
        if ( methods[methodOrOptions] ) {
            return methods[ methodOrOptions ].apply( this, Array.prototype.slice.call( arguments, 1 ));
        } else if ( typeof methodOrOptions === 'object' || ! methodOrOptions ) {
            // Default to "init"
            return methods.init.apply( this, arguments );
        } else {
            $.error( 'Method ' +  methodOrOptions + ' does not exist on jQuery.tooltip' );
        }    
    };


})( jQuery );

基本上,您将函数存储在数组中(作用域为包装函数),并检查输入的参数是否为字符串,如果参数为对象(或为null),则返回默认方法(此处为“ init”)。

然后,您可以像这样调用方法...

$('div').tooltip(); // calls the init method
$('div').tooltip({  // calls the init method
  foo : 'bar'
});
$('div').tooltip('hide'); // calls the hide method
$('div').tooltip('update', 'This is the new tooltip content!'); // calls the update method

Javascripts“ arguments”变量是所有传递的参数的数组,因此它可以与任意长度的函数参数一起使用。


2
这是我使用的方法。您也可以通过$ .fn.tooltip('methodname',params);静态地调用方法。
Rake36

1
非常方便的架构。在调用init方法之前,我还添加了这一行:this.data('tooltip', $.extend(true, {}, $.fn.tooltip.defaults, methodOrOptions));因此,现在初始化后,我可以随时访问选项。
ivkremer

16
对于任何像我是谁第一个说:“哪里的参数变量来自” - developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/... -我已经永远使用JS和从来不知道。你每天学习新的东西!
streetlogics

2
@DiH,我和你在一起。这种方法看起来不错,但它不能让您从以外的任何地方访问全局设置init
史蒂芬·柯林斯

4
该技术存在一个主要问题!它不会像您认为的那样为选择器中的每个元素创建一个新实例,而是仅创建一个附加到选择器本身的实例。查看我的答案以寻求解决方案。
凯文·尤尔科夫斯基

56

这是我用于使用其他方法创建插件的模式。您将使用它像:

$('selector').myplugin( { key: 'value' } );

或者,直接调用方法,

$('selector').myplugin( 'mymethod1', 'argument' );

例:

;(function($) {

    $.fn.extend({
        myplugin: function(options,arg) {
            if (options && typeof(options) == 'object') {
                options = $.extend( {}, $.myplugin.defaults, options );
            }

            // this creates a plugin for each element in
            // the selector or runs the function once per
            // selector.  To have it do so for just the
            // first element (once), return false after
            // creating the plugin to stop the each iteration 
            this.each(function() {
                new $.myplugin(this, options, arg );
            });
            return;
        }
    });

    $.myplugin = function( elem, options, arg ) {

        if (options && typeof(options) == 'string') {
           if (options == 'mymethod1') {
               myplugin_method1( arg );
           }
           else if (options == 'mymethod2') {
               myplugin_method2( arg );
           }
           return;
        }

        ...normal plugin actions...

        function myplugin_method1(arg)
        {
            ...do method1 with this and arg
        }

        function myplugin_method2(arg)
        {
            ...do method2 with this and arg
        }

    };

    $.myplugin.defaults = {
       ...
    };

})(jQuery);

9
与jquery-ui相同的模式,我不喜欢所有魔术字符串,但是还有其他方法!
redsquare

8
这似乎是一种非标准的处理方式-还有什么比链接函数更简单的了吗?谢谢!
Yuval Karmi

2
@yuval-通常jQuery插件返回jQuery或一个值,而不是插件本身。这就是为什么要调用插件时将方法名称作为参数传递给插件的原因。您可以传递任意数量的参数,但是必须调整函数和参数解析。如所示,最好将它们设置在匿名对象中。
tvanfosson

1
;第一行的含义是什么?请向我解释:)
GusDeCooL 2013年

4
@GusDeCooL只是确保我们正在开始一个新的语句,这样我们的函数定义就不会被解释为别人格式不正确的Javascript的参数(即,初始括号不会被当作函数调用运算符)。见stackoverflow.com/questions/7365172/...
tvanfosson

35

那么这种方法呢:

jQuery.fn.messagePlugin = function(){
    var selectedObjects = this;
    return {
             saySomething : function(message){
                              $(selectedObjects).each(function(){
                                $(this).html(message);
                              });
                              return selectedObjects; // Preserve the jQuery chainability 
                            },
             anotherAction : function(){
                               //...
                               return selectedObjects;
                             }
           };
}
// Usage:
$('p').messagePlugin().saySomething('I am a Paragraph').css('color', 'red');

选定的对象存储在messagePlugin闭包中,该函数返回一个对象,该对象包含与插件关联的函数,在每个函数中,您都可以对当前选定的对象执行所需的操作。

您可以在此处测试并使用代码

编辑:更新了代码以保留jQuery可链接性的功能。


1
我很难理解这是什么样子。假设我有需要在第一次运行时执行的代码,则必须首先在我的代码中对其进行初始化-像这样:$('p')。messagePlugin(); 然后在代码中稍后我想调用函数saySomething像这样的$('p')。messagePlugin()。saySomething('something'); 这将不会重新初始化插件,然后调用该函数吗?机箱和选件会是什么样?非常感谢你。-yuval
Yuval Karmi

1
不过,这种方式打破了jQuery的可链接性范式。
tvanfosson

也许这应该是最好的答案
Dragouf

3
每次调用messagePlugin()时,它将使用这两个函数创建一个新对象,不是吗?
w00t

4
这种方法的主要问题是,$('p').messagePlugin()除非调用它返回的两个函数之一,否则它无法保留可链接性。
Joshua Bambrick

18

当前选择的答案的问题是,您实际上并未像您认为的那样为选择器中的每个元素创建自定义插件的新实例……您实际上只是在创建一个实例并传入选择器本身作为范围。

查看这个小提琴以获得更深入的解释。

相反,您需要使用jQuery.each遍历选择器。并为选择器中的每个元素实例化自定义插件的新实例。

这是如何做:

(function($) {

    var CustomPlugin = function($el, options) {

        this._defaults = {
            randomizer: Math.random()
        };

        this._options = $.extend(true, {}, this._defaults, options);

        this.options = function(options) {
            return (options) ?
                $.extend(true, this._options, options) :
                this._options;
        };

        this.move = function() {
            $el.css('margin-left', this._options.randomizer * 100);
        };

    };

    $.fn.customPlugin = function(methodOrOptions) {

        var method = (typeof methodOrOptions === 'string') ? methodOrOptions : undefined;

        if (method) {
            var customPlugins = [];

            function getCustomPlugin() {
                var $el          = $(this);
                var customPlugin = $el.data('customPlugin');

                customPlugins.push(customPlugin);
            }

            this.each(getCustomPlugin);

            var args    = (arguments.length > 1) ? Array.prototype.slice.call(arguments, 1) : undefined;
            var results = [];

            function applyMethod(index) {
                var customPlugin = customPlugins[index];

                if (!customPlugin) {
                    console.warn('$.customPlugin not instantiated yet');
                    console.info(this);
                    results.push(undefined);
                    return;
                }

                if (typeof customPlugin[method] === 'function') {
                    var result = customPlugin[method].apply(customPlugin, args);
                    results.push(result);
                } else {
                    console.warn('Method \'' + method + '\' not defined in $.customPlugin');
                }
            }

            this.each(applyMethod);

            return (results.length > 1) ? results : results[0];
        } else {
            var options = (typeof methodOrOptions === 'object') ? methodOrOptions : undefined;

            function init() {
                var $el          = $(this);
                var customPlugin = new CustomPlugin($el, options);

                $el.data('customPlugin', customPlugin);
            }

            return this.each(init);
        }

    };

})(jQuery);

工作的小提琴

您会注意到在第一个小提琴中如何将所有div始终向右移动完全相同的像素数。那是因为只有一个选择器中的所有元素存在选项对象。

使用上面写的技术,您会注意到在第二个小提琴中,每个div都没有对齐并且是随机移动的(不包括第一个div,因为它的随机数总是在第89行上设置为1)。那是因为我们现在正在为选择器中的每个元素正确实例化一个新的自定义插件实例。每个元素都有其自己的options对象,并且不会保存在选择器中,而是保存在自定义插件本身的实例中。

这意味着您将能够从新的jQuery选择器访问在DOM中的特定元素上实例化的自定义插件的方法,而不必像在第一个小提琴中那样被强制缓存它们。

例如,这将使用第二个小提琴中的技术返回所有选项对象的数组。它将在第一个中返回undefined。

$('div').customPlugin();
$('div').customPlugin('options'); // would return an array of all options objects

这是您必须在第一个小提琴中访问options对象的方式,并且只会返回一个对象,而不是它们的数组:

var divs = $('div').customPlugin();
divs.customPlugin('options'); // would return a single options object

$('div').customPlugin('options');
// would return undefined, since it's not a cached selector

我建议使用上面的技术,而不是当前选择的答案中的一种。


谢谢,这对我有很大帮助,特别是向我介绍了.data()方法。非常便利。FWIW,您还可以使用匿名方法来简化一些代码。
dalemac 2014年

使用这种方法的jQuery chainability是不工作... $('.my-elements').find('.first-input').customPlugin('update'‌​, 'first value').end().find('.second-input').customPlugin('update', 'second value'); returns Cannot read property 'end' of undefinedjsfiddle.net/h8v1k2pL
Alex G

16

jQuery通过引入Widget Factory使得此过程变得容易得多

例:

$.widget( "myNamespace.myPlugin", {

    options: {
        // Default options
    },

    _create: function() {
        // Initialization logic here
    },

    // Create a public method.
    myPublicMethod: function( argument ) {
        // ...
    },

    // Create a private method.
    _myPrivateMethod: function( argument ) {
        // ...
    }

});

初始化:

$('#my-element').myPlugin();
$('#my-element').myPlugin( {defaultValue:10} );

方法调用:

$('#my-element').myPlugin('myPublicMethod', 20);

(这是构建jQuery UI库的方式。)


@ daniel.sedlacek a)“非常糟糕的体系结构”-这是jQuery的标准小部件体系结构b)“在编译时检查了完整性”-JavaScript是一种动态语言c)“ TypeScript”-a?
Yarin 2014年

a)这是争论的话题,b)每个更好的JS IDE都有代码
补全

塞德莱切克先生,这纯属妄想。
mystrdat 2014年

根据文档:该系统称为Widget Factory,作为jQuery UI 1.8的一部分作为jQuery.widget公开。但是,它可以独立于jQuery UI使用。没有 jQuery UI的情况下如何使用$ .widget ?
Airn5475

13

一种更简单的方法是使用嵌套函数。然后,您可以以面向对象的方式链接它们。例:

jQuery.fn.MyPlugin = function()
{
  var _this = this;
  var a = 1;

  jQuery.fn.MyPlugin.DoSomething = function()
  {
    var b = a;
    var c = 2;

    jQuery.fn.MyPlugin.DoSomething.DoEvenMore = function()
    {
      var d = a;
      var e = c;
      var f = 3;
      return _this;
    };

    return _this;
  };

  return this;
};

以及如何调用它:

var pluginContainer = $("#divSomeContainer");
pluginContainer.MyPlugin();
pluginContainer.MyPlugin.DoSomething();
pluginContainer.MyPlugin.DoSomething.DoEvenMore();

不过要小心。创建嵌套函数之前,不能调用它。所以你不能这样做:

var pluginContainer = $("#divSomeContainer");
pluginContainer.MyPlugin();
pluginContainer.MyPlugin.DoSomething.DoEvenMore();
pluginContainer.MyPlugin.DoSomething();

DoEvenMore函数甚至不存在,因为尚未运行创建DoEvenMore函数所需的DoSomething函数。对于大多数jQuery插件,您实际上只会具有一个嵌套函数级别,而不会像我在此处显示的那样具有两个。
只要确保您在创建嵌套函数时就在父函数中的任何其他代码执行之前在父函数的开头定义了这些函数即可。

最后,请注意,“ this”成员存储在名为“ _this”的变量中。对于嵌套函数,如果需要在调用客户端中引用实例,则应返回“ _this”。您不能只在嵌套函数中返回“ this”,因为这将返回对该函数而不是jQuery实例的引用。返回jQuery引用使您可以在返回时链接固有的jQuery方法。


2
太好了-我只想知道为什么jQuery似乎更喜欢按.plugin('method')模式中的名称调用方法?
w00t

6
这是行不通的。如果在两个不同的容器上调用插件,则内部变量将被覆盖(即_this)
mbrochh 2013年

失败:不允许pluginContainer.MyPlugin.DoEvenMore()。DoSomething();
保罗·斯威兹

9

我是从jQuery Plugin Boilerplate获得的

也在jQuery插件样板中描述

// jQuery Plugin Boilerplate
// A boilerplate for jumpstarting jQuery plugins development
// version 1.1, May 14th, 2011
// by Stefan Gabos

// remember to change every instance of "pluginName" to the name of your plugin!
(function($) {

    // here we go!
    $.pluginName = function(element, options) {

    // plugin's default options
    // this is private property and is accessible only from inside the plugin
    var defaults = {

        foo: 'bar',

        // if your plugin is event-driven, you may provide callback capabilities
        // for its events. execute these functions before or after events of your
        // plugin, so that users may customize those particular events without
        // changing the plugin's code
        onFoo: function() {}

    }

    // to avoid confusions, use "plugin" to reference the
    // current instance of the object
    var plugin = this;

    // this will hold the merged default, and user-provided options
    // plugin's properties will be available through this object like:
    // plugin.settings.propertyName from inside the plugin or
    // element.data('pluginName').settings.propertyName from outside the plugin,
    // where "element" is the element the plugin is attached to;
    plugin.settings = {}

    var $element = $(element), // reference to the jQuery version of DOM element
    element = element; // reference to the actual DOM element

    // the "constructor" method that gets called when the object is created
    plugin.init = function() {

    // the plugin's final properties are the merged default and
    // user-provided options (if any)
    plugin.settings = $.extend({}, defaults, options);

    // code goes here

   }

   // public methods
   // these methods can be called like:
   // plugin.methodName(arg1, arg2, ... argn) from inside the plugin or
   // element.data('pluginName').publicMethod(arg1, arg2, ... argn) from outside
   // the plugin, where "element" is the element the plugin is attached to;

   // a public method. for demonstration purposes only - remove it!
   plugin.foo_public_method = function() {

   // code goes here

    }

     // private methods
     // these methods can be called only from inside the plugin like:
     // methodName(arg1, arg2, ... argn)

     // a private method. for demonstration purposes only - remove it!
     var foo_private_method = function() {

        // code goes here

     }

     // fire up the plugin!
     // call the "constructor" method
     plugin.init();

     }

     // add the plugin to the jQuery.fn object
     $.fn.pluginName = function(options) {

        // iterate through the DOM elements we are attaching the plugin to
        return this.each(function() {

          // if plugin has not already been attached to the element
          if (undefined == $(this).data('pluginName')) {

              // create a new instance of the plugin
              // pass the DOM element and the user-provided options as arguments
              var plugin = new $.pluginName(this, options);

              // in the jQuery version of the element
              // store a reference to the plugin object
              // you can later access the plugin and its methods and properties like
              // element.data('pluginName').publicMethod(arg1, arg2, ... argn) or
              // element.data('pluginName').settings.propertyName
              $(this).data('pluginName', plugin);

           }

        });

    }

})(jQuery);

您的方法中断了jQuery链接:$('.first-input').data('pluginName').publicMethod('new value').css('color', red);返回Cannot read property 'css' of undefined jsfiddle.net/h8v1k2pL/1
Alex G

@AlexG在此示例中给出了您要添加的内容,return $element因此在此示例中将其更改为plugin.foo_public_method = function() {/* Your Code */ return $element;}@Salim,感谢您的帮助... github.com/AndreaLombardo/BootSideMenu/pull/34
CrandellWS

6

为时已晚,但也许有一天可以对某人有所帮助。

我当时处在类似的情况下,即使用某些方法创建jQuery插件,并在阅读了一些文章和轮胎后,创建了jQuery插件样板(https://github.com/acanimal/jQuery-Plugin-Boilerplate)。

此外,我用它开发了一个插件来管理标签(https://github.com/acanimal/tagger.js),并写了两篇博客文章,逐步解释了jQuery插件的创建(http:// acuriousanimal。 com / blog / 2013/01/15 / things-i-learned-creating-a-jquery-plugin-part-i /)。


也许是我遇到的关于初学者创建jQuery插件的最佳文章-谢谢;)
Dex Dave

5

你可以做:

(function($) {
  var YourPlugin = function(element, option) {
    var defaults = {
      //default value
    }

    this.option = $.extend({}, defaults, option);
    this.$element = $(element);
    this.init();
  }

  YourPlugin.prototype = {
    init: function() { },
    show: function() { },
    //another functions
  }

  $.fn.yourPlugin = function(option) {
    var arg = arguments,
        options = typeof option == 'object' && option;;
    return this.each(function() {
      var $this = $(this),
          data = $this.data('yourPlugin');

      if (!data) $this.data('yourPlugin', (data = new YourPlugin(this, options)));
      if (typeof option === 'string') {
        if (arg.length > 1) {
          data[option].apply(data, Array.prototype.slice.call(arg, 1));
        } else {
          data[option]();
        }
      }
    });
  };
});

这样,您的plugins对象将作为数据值存储在元素中。

//Initialization without option
$('#myId').yourPlugin();

//Initialization with option
$('#myId').yourPlugin({
  // your option
});

// call show method
$('#myId').yourPlugin('show');

3

那使用触发器呢?有谁知道使用它们有什么缺点吗?好处是可以通过触发器访问所有内部变量,并且代码非常简单。

参见jsfiddle

用法示例

<div id="mydiv">This is the message container...</div>

<script>
    var mp = $("#mydiv").messagePlugin();

    // the plugin returns the element it is called on
    mp.trigger("messagePlugin.saySomething", "hello");

    // so defining the mp variable is not needed...
    $("#mydiv").trigger("messagePlugin.repeatLastMessage");
</script>

插入

jQuery.fn.messagePlugin = function() {

    return this.each(function() {

        var lastmessage,
            $this = $(this);

        $this.on('messagePlugin.saySomething', function(e, message) {
            lastmessage = message;
            saySomething(message);
        });

        $this.on('messagePlugin.repeatLastMessage', function(e) {
            repeatLastMessage();
        });

        function saySomething(message) {
            $this.html("<p>" + message + "</p>");
        }

        function repeatLastMessage() {
            $this.append('<p>Last message was: ' + lastmessage + '</p>');
        }

    });

}

1
cf. 你的评论。我在这里看到的唯一问题可以说是事件系统的滥用。仅使用事件来调用函数是不典型的。似乎过分杀伤,很容易被破坏。通常,您将以发布-订阅的方式使用事件,例如,一个函数发布某个条件“ A”已发生。对“ A”感兴趣的其他实体,侦听“ A”已发生的消息,然后执行某些操作。您似乎将其用作推“命令”,但假设只有一个侦听器。您需要注意不要因添加其他监听器而破坏您的语义。
tvanfosson

@tvanfosson感谢您的评论。我知道这不是一种常见的技术,如果有人不小心添加了事件侦听器,它可能会引起问题,但是如果以插件命名,则可能性很小。我不了解任何与性能相关的问题,但是对我来说,代码本身似乎比其他解决方案要简单得多,但是我可能会遗漏一些东西。
伊什特万Ujj-梅萨罗斯

3

在这里,我想建议使用参数创建简单插件的步骤。

(function($) {
  $.fn.myFirstPlugin = function(options) {
    // Default params
    var params = $.extend({
      text     : 'Default Title',
      fontsize : 10,
    }, options);
    return $(this).text(params.text);
  }
}(jQuery));

$('.cls-title').myFirstPlugin({ text : 'Argument Title' });
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<h1 class="cls-title"></h1>

在这里,我们添加了称为的默认对象,params并使用extend函数设置了选项的默认值。因此,如果我们传递空白参数,则它将设置默认值,否则将设置默认值。

阅读更多: 如何创建JQuery插件


嗨,Gopal Joshi,请提供下一级jquery插件的创建。我们期待您的答复。
Sakthi Karthik

您好@SakthiKarthik,您好,我很快将在我的博客中发布新教程
Gopal Joshi

1
嗨@SakthiKarthik,你可以参考上一个新的水平新文章jQuery插件这里sgeek.org/...
戈帕尔·乔希

2

试试这个:

$.fn.extend({
"calendar":function(){
    console.log(this);
    var methods = {
            "add":function(){console.log("add"); return this;},
            "init":function(){console.log("init"); return this;},
            "sample":function(){console.log("sample"); return this;}
    };

    methods.init(); // you can call any method inside
    return methods;
}}); 
$.fn.calendar() // caller or 
$.fn.calendar().sample().add().sample() ......; // call methods

1

这是我的简单版本。与之前发布的类似,您将打电话给:

$('#myDiv').MessagePlugin({ yourSettings: 'here' })
           .MessagePlugin('saySomething','Hello World!');

-或直接@ plugin_MessagePlugin

$elem = $('#myDiv').MessagePlugin();
var instance = $elem.data('plugin_MessagePlugin');
instance.saySomething('Hello World!');

MessagePlugin.js

;(function($){

    function MessagePlugin(element,settings){ // The Plugin
        this.$elem = element;
        this._settings = settings;
        this.settings = $.extend(this._default,settings);
    }

    MessagePlugin.prototype = { // The Plugin prototype
        _default: {
            message: 'Generic message'
        },
        initialize: function(){},
        saySomething: function(message){
            message = message || this._default.message;
            return this.$elem.html(message);
        }
    };

    $.fn.MessagePlugin = function(settings){ // The Plugin call

        var instance = this.data('plugin_MessagePlugin'); // Get instance

        if(instance===undefined){ // Do instantiate if undefined
            settings = settings || {};
            this.data('plugin_MessagePlugin',new MessagePlugin(this,settings));
            return this;
        }

        if($.isFunction(MessagePlugin.prototype[settings])){ // Call method if argument is name of method
            var args = Array.prototype.slice.call(arguments); // Get the arguments as Array
            args.shift(); // Remove first argument (name of method)
            return MessagePlugin.prototype[settings].apply(instance, args); // Call the method
        }

        // Do error handling

        return this;
    }

})(jQuery);

1

以下插件结构利用jQuery- data()-method以提供公共接口内部插件的方法/ -settings(同时保留jQuery的chainability):

(function($, window, undefined) { 
  const defaults = {
    elementId   : null,
    shape       : "square",
    color       : "aqua",
    borderWidth : "10px",
    borderColor : "DarkGray"
  };

  $.fn.myPlugin = function(options) {
    // settings, e.g.:  
    var settings = $.extend({}, defaults, options);

    // private methods, e.g.:
    var setBorder = function(color, width) {        
      settings.borderColor = color;
      settings.borderWidth = width;          
      drawShape();
    };

    var drawShape = function() {         
      $('#' + settings.elementId).attr('class', settings.shape + " " + "center"); 
      $('#' + settings.elementId).css({
        'background-color': settings.color,
        'border': settings.borderWidth + ' solid ' + settings.borderColor      
      });
      $('#' + settings.elementId).html(settings.color + " " + settings.shape);            
    };

    return this.each(function() { // jQuery chainability     
      // set stuff on ini, e.g.:
      settings.elementId = $(this).attr('id'); 
      drawShape();

      // PUBLIC INTERFACE 
      // gives us stuff like: 
      //
      //    $("#...").data('myPlugin').myPublicPluginMethod();
      //
      var myPlugin = {
        element: $(this),
        // access private plugin methods, e.g.: 
        setBorder: function(color, width) {        
          setBorder(color, width);
          return this.element; // To ensure jQuery chainability 
        },
        // access plugin settings, e.g.: 
        color: function() {
          return settings.color;
        },        
        // access setting "shape" 
        shape: function() {
          return settings.shape;
        },     
        // inspect settings 
        inspectSettings: function() {
          msg = "inspecting settings for element '" + settings.elementId + "':";   
          msg += "\n--- shape: '" + settings.shape + "'";
          msg += "\n--- color: '" + settings.color + "'";
          msg += "\n--- border: '" + settings.borderWidth + ' solid ' + settings.borderColor + "'";
          return msg;
        },               
        // do stuff on element, e.g.:  
        change: function(shape, color) {        
          settings.shape = shape;
          settings.color = color;
          drawShape();   
          return this.element; // To ensure jQuery chainability 
        }
      };
      $(this).data("myPlugin", myPlugin);
    }); // return this.each 
  }; // myPlugin
}(jQuery));

现在,您可以使用以下语法调用内部插件方法来访问或修改插件数据或相关元素:

$("#...").data('myPlugin').myPublicPluginMethod(); 

只要您从myPublicPluginMethod()jQuery-chainability的实现内部返回当前元素(this),就可以保留它-因此,可以进行以下工作:

$("#...").data('myPlugin').myPublicPluginMethod().css("color", "red").html("...."); 

以下是一些示例(有关详细信息,请查看此小提琴):

// initialize plugin on elements, e.g.:
$("#shape1").myPlugin({shape: 'square', color: 'blue', borderColor: 'SteelBlue'});
$("#shape2").myPlugin({shape: 'rectangle', color: 'red', borderColor: '#ff4d4d'});
$("#shape3").myPlugin({shape: 'circle', color: 'green', borderColor: 'LimeGreen'});

// calling plugin methods to read element specific plugin settings:
console.log($("#shape1").data('myPlugin').inspectSettings());    
console.log($("#shape2").data('myPlugin').inspectSettings());    
console.log($("#shape3").data('myPlugin').inspectSettings());      

// calling plugin methods to modify elements, e.g.:
// (OMG! And they are chainable too!) 
$("#shape1").data('myPlugin').change("circle", "green").fadeOut(2000).fadeIn(2000);      
$("#shape1").data('myPlugin').setBorder('LimeGreen', '30px');

$("#shape2").data('myPlugin').change("rectangle", "red"); 
$("#shape2").data('myPlugin').setBorder('#ff4d4d', '40px').css({
  'width': '350px',
  'font-size': '2em' 
}).slideUp(2000).slideDown(2000);              

$("#shape3").data('myPlugin').change("square", "blue").fadeOut(2000).fadeIn(2000);   
$("#shape3").data('myPlugin').setBorder('SteelBlue', '30px');

// etc. ...     

0

实际上,可以使用来使它以“不错”的方式工作defineProperty。其中“ nice”表示无需使用()获取插件名称空间,也不必通过字符串传递函数名称。

兼容性nit: defineProperty在IE8及更低版本的旧版浏览器中不起作用。 警告: $.fn.color.blue.apply(foo, args)无效,您需要使用foo.color.blue.apply(foo, args)

function $_color(color)
{
    return this.css('color', color);
}

function $_color_blue()
{
    return this.css('color', 'blue');
}

Object.defineProperty($.fn, 'color',
{
    enumerable: true,
    get: function()
    {
        var self = this;

        var ret = function() { return $_color.apply(self, arguments); }
        ret.blue = function() { return $_color_blue.apply(self, arguments); }

        return ret;
    }
});

$('#foo').color('#f00');
$('#bar').color.blue();

JSFiddle链接


0

根据jquery标准,您可以创建插件,如下所示:

(function($) {

    //methods starts here....
    var methods = {
        init : function(method,options) {
             this.loadKeywords.settings = $.extend({}, this.loadKeywords.defaults, options);
             methods[method].apply( this, Array.prototype.slice.call( arguments, 1 ));
             $loadkeywordbase=$(this);
        },
        show : function() {
            //your code here.................
        },
        getData : function() {
           //your code here.................
        }

    } // do not put semi colon here otherwise it will not work in ie7
    //end of methods

    //main plugin function starts here...
    $.fn.loadKeywords = function(options,method) {
        if (methods[method]) {
            return methods[method].apply(this, Array.prototype.slice.call(
                    arguments, 1));
        } else if (typeof method === 'object' || !method) {
            return methods.init.apply(this, arguments);
        } else {
            $.error('Method ' + method + ' does not ecw-Keywords');
        }
    };
    $.fn.loadKeywords.defaults = {
            keyName:     'Messages',
            Options:     '1',
            callback: '',
    };
    $.fn.loadKeywords.settings = {};
    //end of plugin keyword function.

})(jQuery);

如何调用这个插件?

1.$('your element').loadKeywords('show',{'callback':callbackdata,'keyName':'myKey'}); // show() will be called

参考:链接


0

我认为这可能对您有帮助...

(function ( $ ) {
  
    $.fn.highlight = function( options ) {
  
        // This is the easiest way to have default options.
        var settings = $.extend({
            // These are the defaults.
            color: "#000",
            backgroundColor: "yellow"
        }, options );
  
        // Highlight the collection based on the settings variable.
        return this.css({
            color: settings.color,
            backgroundColor: settings.backgroundColor
        });
  
    };
  
}( jQuery ));

在上面的例子中我已经创建了一个简单的jQuery 亮点 plugin.I分享了其中我对讨论的文章如何创建自己的jQuery插件从基础到高级。我认为您应该检查一下... http://mycodingtricks.com/jquery/how-to-create-your-own-jquery-plugin/


0

以下是一个小的插件,具有用于调试目的的警告方法。将此代码保存在jquery.debug.js文件中:JS:

jQuery.fn.warning = function() {
   return this.each(function() {
      alert('Tag Name:"' + $(this).prop("tagName") + '".');
   });
};

HTML:

<html>
   <head>
      <title>The jQuery Example</title>

      <script type = "text/javascript" 
         src = "http://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>

      <script src = "jquery.debug.js" type = "text/javascript"></script>

      <script type = "text/javascript" language = "javascript">
         $(document).ready(function() {
            $("div").warning();
            $("p").warning();
         });
      </script> 
   </head>

   <body>
      <p>This is paragraph</p>
      <div>This is division</div>
   </body>

</html>

0

这是我的方法:

(function ( $ ) {

$.fn.gridview = function( options ) {

    ..........
    ..........


    var factory = new htmlFactory();
    factory.header(...);

    ........

};

}( jQuery ));


var htmlFactory = function(){

    //header
     this.header = function(object){
       console.log(object);
  }
 }

-2

您所做的基本上是通过新方法扩展jQuery.fn.messagePlugin对象。这很有用,但不适用于您的情况。

你要做的就是使用这种技术

function methodA(args){ this // refers to object... }
function saySomething(message){ this.html(message);  to first function }

jQuery.fn.messagePlugin = function(opts) {
  if(opts=='methodA') methodA.call(this);
  if(opts=='saySomething') saySomething.call(this, arguments[0]); // arguments is an array of passed parameters
  return this.each(function(){
    alert(this);
  });

};

但是您可以实现您想要的,我的意思是有一种方法可以完成$(“#mydiv”)。messagePlugin()。saySomething(“ hello”); 我的朋友他开始写有关lugin的文章,以及如何通过您的功能链扩展lugin的内容,这是他博客的链接

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.