如何编写自己的jQuery插件?

对于那些不知道的人来说,jQuery是一个JavaScript库,它包含了许多特性,非常小而且速度很快。它还包括一个易于使用的API,在所有浏览器上都是兼容的,并且可以很容易的进行HTML遍历、动画、DOM操作和事件处理。它不仅可扩展,而且经久耐用。因此,客户端脚本自开发以来变得容易得多。

什么是jQuery插件?

jQuery由原型对象组成,在某些时候可能需要一些操作和扩展。出于同样的目的,jQuery插件被设计为对象继承添加的任何其他方法的一种方式。不仅如此,在创建jQuery对象时,这些附加方法并不是孤立的,而是在创建jQuery对象时使用其余的方法(已经继承的)调用。jQuery插件可以jQuery库中存在的各种方法的形式单独使用。每个方法都是一个插件。但是,在新的情况下,插件也可以自定义创建,这并不是一项非常困难的任务。

jQuery是如何工作的?

要理解jQuery是如何工作的,你需要遵循以下步骤:

· 创建一个带有所有基本标记的HTML文档,并调用jQuery.js文件。

· 开发人员预先考虑并将代码的可执行命令封装到onload()函数中,以确保在将文档加载到浏览器后立即执行命令。

· 有时,由于图像加载的延迟,文档不会完整加载。为了确保加载后可以处理完整的文档,开发人员在其代码中提供了一个ready事件。

· ready事件的完整脚本(封装在其中的函数)放在前面创建的HTML文档中。保存和运行文档将确保你的代码使用输出执行。

· 此函数可以包含执行特定任务的任何事件(子事件)或命令。

什么是基本插件签名?

$.fn.pluginName = function() {
this.css( "color", "yellow" );
 }; 
$( "a" ).pluginName();

如上面所示,插件开始其身份创建。pluginName替换为正在创建的插件的名称,后跟一个函数以及括号中的所有必需参数。接下来,函数中的下一个语句(this.css确保将CSS应用于某些文本,使其颜色变为黄色。最后一行调用插件函数将所有带有a“标签的链接变为黄色。

保护$Alias并添加作用域

编写jQuery插件时总是假定$使用jQuery函数的别名。$在JavaScript库中非常有名。因此,当需要多个jQuery库时,使用$可能会产生冲突。因此,为了使我们能够将jQuery与其他插件一起使用。必须将代码放在立即调用函数的表达式中。这之后是jQuery的传递,然后命名它的参数$.

添加私有方法和变量

在JavaScript中,函数包含多个变量和其他函数,这些变量和函数主要可以在函数内部访问,从而使元素成为私有。立即调用的函数表达式提供了访问私有变量和方法的最佳方法。

在解析了别名($)之后,可以在此处理解添加私有方法或变量:

(function($) {
  $.fn.pluginName = function() {
   // private variables
   var privatevar1 = '';
   var privatevar2 = '';
   // private methods
   var myPrivateMethod = function() {
    // do something ...
   }
})(jQuery);

只能通过立即调用函数才能添加私有变量并启用其使用:

(function($){
  var col = “yellow”;$.fn.pluginName = function() {
  this.css("color", col);
  return this;
  };
}(jQuery)); 

只能在函数的范围内调用私有方法。只有其他私有方法或公共方法有权调用这些私有方法。这也适用于访问私有变量。

添加公共方法

向jQuery插件添加方法是在私有方法中完成的。唯一的区别是方法的执行。当该方法提供“this”运算符时,该方法变为公共方法。这样,它也可以在函数范围之外访问。添加此类公共方法的目的可以是在范围外执行函数,也可以从范围外访问公共变量和方法。

(function($) {
  $.fn.pluginName = function() {
   // public methods
   this.initialize = function() {
    // do something ...
    return this;
   };
   this.myPublicMethod = function() {
    // do something ...
   };
})(jQuery);

接受插件自定义选项

在某些情况下,当你继续添加插件时,插件会变得越来越复杂。因此,最好让你的插件开始接受一些选项并使其可自定义。

(function($) {
    $.fn.pluginName = function(options) {
        var defaults = {
            color: "white",
            'background-color': "#556b2f"
        };
        var settings = $.extend({}, defaults, options);
        return this.css({
            color: settings.color,
            'background-color': settings.background - color
        });
    };
}(jQuery));

结合所有技术,编译了以下示例插件:

(function($) {
    $.fn.pluginName = function(options) {
        var defaults = {
            color: "white",
            'background-color': "#556b2f"
        };
        var settings = $.extend({}, defaults, options);
        if (this.length > 1) {
            this.each(function() { $(this).pluginName(options) });
            return this;
        }
        // private variables
        var privatevar1 = '';
        var privatevar2 = '';
        // private methods
        var myPrivateMethod = function() {
            // do something ...
        }
        // public methods 
        this.initialize = function() {
            // do something ...
            return this;
        };
        this.myPublicMethod = function() {
            // do something ...
        };
        return this.initialize();
    }
})(jQuery);

这里,方法'each()'用于循环遍历元素集合。此外,此方法的返回值是this.append()方法,该方法接受回调,返回时我们将能够看到集合中要追加的元素。

原文标题《How to Write Your Own jQuery Plugin 》

作者:Rajesh Kumar

译者:lemon

不代表云加社区观点,更多详情请查看原文链接

原文链接:https://dzone.com/articles/how-to-write-your-own-jquery-plugin

原文作者:Rajesh Kumar

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏自动化测试实战

《selenium2 python 自动化测试实战》(7)——定位一组对象

3005
来自专栏每日一篇技术文章

微信小程序_06 将臃肿的单页js文件拆开

小程序中每一个页面对应一个Page()方法,我们需要把变量和组件的各种事件都写在一个对象里,然后把对象作为这个参数传递给Page方法

1092
来自专栏IMWeb前端团队

移动端minimvvm框架qvm实现

gitHub地址 1,移动端minimvvm框架qvm实现 qvm概念,一个适用于移动端的mini mvvm(什么是mvvm?没了解的同学自己去了解)框架。参考...

22010
来自专栏我的小碗汤

一个神秘现象引发对beego框架的思考

小强最近在项目中遇到了一个很奇怪的问题:在整改日志规范时,为了避免影响现有的代码结构以及改动尽可能小的前提下,在调用记日志的SDK处将某一个字段值首字母改为大写...

774
来自专栏程序员互动联盟

【答疑解惑】getchar()与EOF

先看下面的代码: while((c = getchar()) != EOF){ putchar(c); } 这一段代码是The C Programming ...

3749
来自专栏web前端

SASS学习笔记(一)

一、为什么使用SASS CSS不是编程语言,没有变量、条件语句等等,只是单纯的描述,因此为CSS加入编程元素(即“CSS预处理器”)。其基本思想:用一种专门的编...

2058
来自专栏FreeBuf

XSS编码剖析

作者 0xExploit 0×00 引言 很多不了解html、js编码的童鞋挖掘xss漏洞时,都是一顿乱插,姿势对了,就能获得快感,姿势不对,就么反应。另外在f...

3068
来自专栏逸鹏说道

Python3 与 C# 并发编程之~ 进程篇中

接着上面继续拓展,补充说说获取函数返回值。 上面是通过成功后的回调函数来获取返回值,这次说说自带的方法:

1363
来自专栏cloudskyme

使用jquery-easyui写的CRUD插件(1)

写插件先看看jqeury的插件如何写,先了解一下如何写插件的代码。 jQuery插件的开发包括两种: 一种是类级别的插件开发,即给jQuery添加新的全局函数,...

3849
来自专栏Ryan Miao

js基础-表单验证和提交

基础知识: 原始提交如下: 1 <form action="/login" method="post" id="form1"> 2 <span>用户<...

5785

扫码关注云+社区

领取腾讯云代金券