[jQuery] jQueryプラグインを作成する

投稿日：2018年4月21日更新日：2018年5月2日

jQueryではプラグインというものを作成することができます。
いろいろな箇所で使われる処理をプラグインとして作成しておけば、その処理を簡単に呼び出すことができます。

サンプルソース

例）文字色と文字サイズをセットするプラグインサンプル

<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="utf-8">
<title>jQueryプラグインサンプル</title>
<script src="http://code.jquery.com/jquery-3.2.1.min.js"></script>
<script>
$(function(){
  (function($){
    //文字色をセットする
    $.fn.setColor = function(colStr){
      this.css("color", colStr);
      return this;  //メソッドチェーンに対応させるためthisを返す
    };

    //文字サイズをセットする
    $.fn.setSize = function(size){
      this.css("font-size", size);
      return this;  //メソッドチェーンに対応させるためthisを返す
    };
  }(jQuery));

  //btn1クリックイベント
  $('#btn1').click(function(){
    $("#d1").setColor("blue").setSize(24);  //文字色に青、文字サイズに24を設定
  });
});
</script>
</head>
<body>
  <div id="d1">あいうえお</div>
  <input type="button" value="ボタン" id="btn1">
</body>
</html>

<!DOCTYPE html>

<head>

<title>jQueryプラグインサンプル</title>

$(function(){

(function($){

//文字色をセットする

$.fn.setColor = function(colStr){

this.css("color", colStr);

return this; //メソッドチェーンに対応させるためthisを返す

};

//文字サイズをセットする

$.fn.setSize = function(size){

this.css("font-size", size);

return this; //メソッドチェーンに対応させるためthisを返す

};

}(jQuery));

//btn1クリックイベント

$('#btn1').click(function(){

$("#d1").setColor("blue").setSize(24); //文字色に青、文字サイズに24を設定

});

</script>

</head>

<body>

<div id="d1">あいうえお</div>

</body>

</html>

上記例は、「ボタン」を押すと、"あいうえお"の文字が青色・24pxになります。

解説

プラグインは、$.fn.xxx　という形で定義します。
プラグインはメソッドチェーンに対応させるため、自身(this)を返すようにします。

執筆者：とら