jQueryプラグインとは何ですか? jQueryプラグインの書き方を共有する

jQuery プラグインとは何ですか?一般的な jQuery プラグインは、オブジェクト メソッドをカプセル化するプラグイン、グローバル関数をカプセル化するプラグイン、セレクター プラグインの 3 種類に主に分類されます。では、これら 3 つの jQuery プラグインに基づく各 jQuery プラグインの作成と使用方法は何でしょうか?次に、jQuery プラグインの使用と作成について説明します。

jQuery プラグインの分類:

1. オブジェクトのメソッドをカプセル化するプラグイン

この種類のプラグインはオブジェクトをカプセル化しますセレクターを通じて取得された jQuery オブジェクトを操作するための最も一般的なプラグインです。

2. グローバル関数をカプセル化するプラグイン

jQuery 名前空間に独立した関数を追加できます。たとえば、jQuery.noConflict() メソッド、一般的に使用される jQuery.ajax() メソッド、および最初のスペースを削除する jQuery.trim() メソッドはすべて、jQuery 内のグローバル関数としてカーネルにアタッチされるプラグインです。

3.セレクター プラグイン

場合によっては、セレクター プラグインを使用する必要があります。

プラグインの基本ポイント

1. jQuery プラグインのファイル名は jquery.[プラグイン名] とすることを推奨します。 js を使用して、他の JavaScript ライブラリ プラグインとの混同を避けます。

2. すべてのオブジェクト メソッドは jQuery.fn オブジェクトにアタッチされ、すべてのグローバル関数は jQuery オブジェクト自体にアタッチされる必要があります。

3. プラグイン内部では、内部の this が DOM 要素を指す click() メソッドなどの一般的なメソッドとは異なり、this はセレクターを通じて現在取得されている jQuery オブジェクトを指します。

4. this.each を通じてすべての要素を横断できます。

5. すべてのメソッドまたは関数プラグインはセミコロンで終わる必要があります。そうしないと、圧縮中に問題が発生する可能性があります。より安全にするために、プラグインのヘッダーにセミコロンを追加して、他の人の不規則なコードがプラグインに影響を与えるのを防ぐこともできます。

6. プラグインをチェーンできるようにするために、プラグインは jQuery オブジェクトを返す必要があります。プラグインが文字列や配列など、取得する必要がある数量を返す必要がある場合を除きます。

7. プラグイン内の jQuery オブジェクトのエイリアスとして $ を使用することは避け、代わりに完全な jQuery を使用してそれを表します。もちろん、クロージャー手法を使用してこの問題を回避し、プラグインが引き続き $ を jQuery のエイリアスとして使用できるようにすることもできます。多くのプラグインがこれを行います。

プラグインのクロージャ

クロージャについては、ECMAScript で簡単に説明されています。内部関数 (つまり、内部の別の場所にある関数定義と関数式) の使用を許可します。さらに、これらの内部関数の 1 つが、それらを含む外部関数の外部で呼び出された場合、これらの内部関数は、それらが含まれる外部関数で宣言されたすべてのローカル変数、パラメーター、およびその他の内部関数にアクセスできます。クロージャーが形成されます。つまり、内側の関数は外側の関数が戻った後に実行されます。この内部関数が実行されるときも、ローカル変数、パラメーター、および外部関数の他の内部関数にアクセスする必要があります。これらのローカル変数、パラメータ、関数宣言の値は（最初は）外側の関数が戻ったときの値ですが、内側の関数の影響も受けます。

最初に匿名関数 function(){/*ここにコードを配置*/} を定義し、それを括弧で囲んで (function(){/*ここにコードを配置*/}) とします。 () 演算子を介して実行されます。内部関数で使用するためにパラメータを渡すことができます。

//互換性を高めるために、先頭の前にセミコロンがあることに注意してください:

;(function($){ //开始时将$作为匿名函数的形参
 
/*这里放置代码，可以使用$作为jQuery的缩写别名*/
 
})(jQuery); //这里就将jQuery作为实参传递给匿名函数了

上記は、一般的な jQuery プラグインの構造です。

jQuery プラグインの仕組み

jQuery には、jQuery 関数を拡張するための 2 つのメソッド、jQuery.fn.extend() メソッドと jQuery.extend() メソッドが用意されています。 。前者は前述の 3 つのプラグイン タイプのうちの最初のプラグインに使用され、後者は後の 2 つのプラグインを拡張するために使用されます。どちらのメソッドも、Object 型のパラメーターを 1 つ受け入れます。 Object オブジェクトの「名前と値のペア」は、それぞれ「関数またはメソッドの名前/関数本体」を表します。

jQuery.extend() メソッドには、jQuery オブジェクトを拡張できることに加えて、既存の Object オブジェクトを使用および拡張する強力な機能もあります。

jQuery コードは次のとおりです:

jQuery.extend(target,obj1,…….[objN])
 
   用一个或多个其它对象来扩展一个对象，然后返回被扩展的对象。
   例如合并settings对象和options对象，修改并返回settings对象。
 
 
var settings={validate:false,limit:5,name:”foo”};
 
var options={validate:true,name:”bar”};
 
var newOptions=jQuery.extend(settings,options);

結果は次のとおりです:

newOptins={valitdate:true,limit:5,name:”bar”};

jQuery.extend() メソッドは、一連のデフォルト パラメータを設定するためによく使用されます。次のコードのようなプラグイン メソッド 表示:

function foo(options){
 
options=jQuery.extend({
 
name:”bar”,
 
limit:5,
 
datatype:”xml”
 
},options);
 
};

foo() メソッドの呼び出し時に、渡されたパラメータ オプション オブジェクトに対応する値が設定されている場合は、その設定値が使用され、それ以外の場合はデフォルトが使用されます。値が使用されます。コードは次のとおりです。

foo({name:”a”,length:”4”,dataType:”json”});
 
foo({name:”a”,length:”4”});
 
foo({name:”a”});
 
foo();

jQuery.extend() メソッドを使用すると、渡されたパラメータでデフォルト値を簡単にオーバーライドできます。この時点では、パラメータ リストの代わりにマップが渡されることを除いて、メソッド呼び出しは同じままです。このメカニズムは、各パラメーターを検出する従来の方法よりも柔軟であるだけでなく、より簡潔です。さらに、名前付きパラメーターを使用すると、新しいオプションを追加しても過去に記述されたコードに影響を与えず、開発者にとってより直感的かつ明確に使用できるようになります。

jQuery プラグインの作成

1. jQuery オブジェクト メソッドをカプセル化するプラグイン

設定およびcolor を取得します

最初に、color() プラグインの作成方法を紹介します。このプラグインは、以下の 2 つの機能を実現するために使用されます。

(1)设置匹配元素的颜色。

(2)获取匹配的元素（元素集合中的第1个）的颜色。

首先将该插件按规范命名为jquery.color.js。

然后再JavaScript文件里搭好框架.由于是对jQuery对象的方法扩展，因此采用第1类方法jQuery.fn.extend()来编写。

 ;(function($){
 
$.fn.extend({
 
“color”:function(value){
 
//这里写插件代码
 
}
 
});
 
})(jQuery);

这里给这个方法提供一个参数value，如果调用了方法的时候传递了value这个参数，那么就是用这个值来设置字体颜色；否则就是匹配元素的字体颜色的值。

首先，实现第1个功能，设置字体颜色。注意，由于插件内部的this指向的是jQuery对象，而非普通的DOM对象。代码如下：

;(function($){
 
$.fn.extend({
 
“color”:function(value){
 
return this.css(“color”,value);
 
}
 
});
 
})(jQuery);

接下来实现第2个功能。如果没用给方法传递参数，那么就是获取集合对象中第1个对象的color的值。由于css()方法本身就具有返回第1个匹配元素样式值的功能，因此此处无需通过eq()来获取第1个元素。只要这两个方法结合起来,判断一下value的值是否是undefined即可。

jQuery代码如下：

;(function($){
 
$.fn.extend({
 
“color”:function(value){
 
if(color===undefined){
 
return this.css(“color”,value);
 
}else{
 
Return this.css(“color”,value);
 
}
 
}
 
});
 
})(jQuery);

这样一来，插件也就完成了。现在来测试一下代码。

<script type=”text/javascript”>
 
//插件编写
 
;(function($){
 
$.fn.extend({
 
“color”:function(value){
 
if(color===undefined){
 
return this.css(“color”,value);
 
}else{
 
Return this.css(“color”,value);
 
}
 
}
 
});
 
})(jQuery);
 
 
 
//插件应用
 
$(function(){
 
//查看第一个div的color样式值
 
alert($(“div”).color()+”\n返回字符串，证明此插件可用。”);
 
//把所有的div字体颜色都设为红色
 
alert($(“div”).color(“red”)+”\n返回object证明得到的是jQuery对象。“)；
 
}）
 
</script>
 
<div style=”color:red”>red</div>
 
<div style=”color:blue”>blue</div>
 
<div style=”color:green”>green</div>
 
<div style=”color:yellow”>yellow</div>
    另外，如果要定义一组插件，可以使用如下所示的写法：
 
:(function($){
 
$.fn.extend({
 
"color":function(value){
 
//插件代码
 
},
 
"border":function(value){
 
//插件代码
 
},
 
"background":function(value){
 
//插件代码
 
}
 
};
 
})(jQuery);

表格隔行变色插件

表格隔行变色的代码如下：

$("tbody>tr:odd").addClass("odd");
 
$("tbody>tr:even").addClass("even");
 
$('tbody>tr').click(function(){
 
//判断是否选中
 
var hasSelected=$(this).hasClass('selected');
 
//如果选中，则移出selected类，否则就加上selected类
 
$(this)[hasSelected?"removeClass":"addClass"]('selected')
 
//查找内部的checkbox,设置对应的属性
 
.find('checkbox').attr('checked'.!hasSelected);
 
});
 
 
 
//如果复选框默认情况下是选择的，则高色
 
$('tbody>tr:has(:checked)').addClass('selected');

首先把插件方法取名为alterBgColor，然后为该插件方法搭好框架，jQuery代码如下：

;(function($){
 
$.fn.extend({
 
"alterBgColor":function(options){
 
//插件代码
 
}
 
});
 
})(jQuery);

框架完成后，接下来就需要为options定义默认值。默认构建这样({odd:"odd",even:"even",selected:"selected"})一个Object。这样就可以通过$("#sometable").alterBgColor({odd:"odd",even:"even",selected:"selected"})自定义奇偶行的样式类名以及选中后的样式类名。同时，直接使用$("#sometable").alterBgColor()就可以应用 默认的样式类名。

jQuery代码如下：

;(function($){
 
$.fn.extend({
 
"alterBgColor":function(options){
 
options=$.extend({
 
odd:"odd", /*偶数行样式*/
 
even:"even", /*奇数行样式*/
 
selected:"selected" /*选中行样式*/
 
},options);
 
}
 
});
 
})(jQuery);

如果在后面的程序中需要使用options对象的属性，可以使用如下的方式来获得：

options.odd; //获取options对象中odd属性的值
 
options.even; //获取options对象中even属性的值
 
options.selected; //获取options对象中selected属性的值

接下来就需要把这些值放到程序中，来代替先前程序中的固定值。

最后就是匹配元素的问题了。显然不能直接用$('tbody>tr')选择表格行，这样会使页面中全部的元素都隔行变色。应该使用选择器选中某个表格，执行alterBgColor()方法后，将对应的表格内元素进行隔行变色。因此，需要把所有通过$('tbody>tr')选择的对象改写成$('tbody>tr',this)，表示在匹配的元素内（当前表格内）查找，并应用上一步中的默认值。jQuery代码如下：

;(function($){
 
$.fn.extend({
 
"alterBgColor":function(options){
 
//设置默认值
 
options=$.extend({
 
odd."odd",
 
even."even",
 
selected:"selected"
 
},options);
 
$("tbody>tr:odd",this).addClass(options,odd);
 
$("tbody>tr:even",this).addClass(options,even);
 
$("tbody>tr",this).click(function(){
 
//判断是否选中
 
var hasSelected=$(this).hasClass(options,selected);
 
//如果选中，则移出selected类，否则加上selected类
 
$(this)[hasSelected?"removeClass":"addClass"](options,selected)
 
//查找内部的checkbox,设置对应属性
 
.find(':checkbox').attr('checked',!hasSelected);
 
});
 
//如果单选框默认情况下是选择的，则高色
 
$('tbody>tr:has(:checkd),this').addClass(options,selected);
 
rerturn this; //返回this，使方法可链
 
}
 
});
 
})(jQuery);

在代码的最后，返回this，让这个插件具有可链性。
此时，插件就完成了。现在来测试这个插件。构造两个表格，id分别为table1和table2，然后使用其中一个

$('#table2')
.alterBgColor() //应用插件
 
.find("th").css("color","red"); //可链式操作

需要注意的是，jQuery的选择符可能会匹配1个或者多个元素。因此，在编写插件时必须考虑到这些情况。可以在插件内部调用each()方法来遍历匹配元素，然后执行相应的方法，this会依次引用每个DOM元素。如下jQuery代码所示：

 ;(function($)){
 
$.fn.extend({
 
"SomePlugin":function(options){
 
return this.each(function(){
 
//这里置放代码
 
});
 
}
 
});
 
})(jQuery);

相关推荐：

jQuery简单滚动插件

jquery.tmpl JQuery模板插件_jquery

以上がjQueryプラグインとは何ですか? jQueryプラグインの書き方を共有するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。