jQuery.fn のfnってどういう意味? $.fnの使い方[jQuery]

jQueryのソースコードやライブラリなどを見ていると$.fnみたいな記述があると思います。
これが何を参照しているのかの簡単な解説と使い方の紹介です。

jQuery.fn のfnってどういう意味?

結論から言ってしまうと、fnprototypeプロパティのエイリアスです。
javascriptはprototypeプロパティを使って、既存のコンストラクタにメソッドを追加していくことが可能です。

簡単なprototypeのサンプル

// constructor function
var Product = function(name, price) {
    this.name = name;
    this.price = price;
}

var testProduct = new Product('banana', 100);
console.log( testProduct );

// result
{"name":"banana","age":100}

上記で基本的なコンストラクタを作成してみました。実際にprototypeプロパティを使ってメソッドを追加

// add method
Product.prototype.getName = function() {
    return this.name;
}

// add property
Product.prototype.stock = 10;

上記のように、あとから、<code>prototype</code>プロパティを使うことによって、既存のコンストラクタに新しいプロパティやメソッドを追加することが可能です。

$.fnの使い方

prototypeプロパティのエイリアスであることは分かったけど、実際にどのように使用できるのかを解説します。

プロパティを追加して、プラグインを作成する

$.fnprototypeのエイリアスであるということは、上記例のように、プロパティやメソッドを追加できます。
簡単なメソッドを追加してみます。

簡単なプラグインのサンプル

$.fn.textRed = function() {
    this.css("color", "red");
};

// surrounded by span turns red
$("span").textRed();

簡単ですね?実際にプラグインを実装する際は下記のことに気を付けてください。

メソッドチェーンを有効にする

// Care jQuery Method Chaining
$.fn.textRed = function(){
    this.css("color", "red");
    return this;
};

// What is Method Chaining?
$("span").textRed().addClass("warning");

メソッドチェーンを使用可能にするために、return thisを追記します。そうすることで、上記例でtextRed()に続けて記載したaddClass()が機能するようになります。

ほかのライブラリと併用される・併用することを想定する

$はjQueryのエイリアスなのですが、ほかのライブラリなどでも使用されるケースもあります。
なので、名前が被らないように下記のようにスコープを限定して記載します。

(function ($) {
    $.fn.textRed= function() {
        this.css( "color", "red" );
        return this;
    };
}(jQuery));

以上簡単なプラグインの作成法でした。

そのほかの、$.fnの使い方

例えばですが、こんな使い方もできます。
・基本となる、例えばbase.js、javascriptファイルを一つ作成して全部のページで読み込む。
・フレックススライダーなどのライブラリを導入するが、ライブラリは使用するページのみ読み込む。
上記の場合、base.jsにフレックススライダーの記述を書くとライブラリを読み込んでいないページでエラーになります。
そのため、スライダーを読み込んだページを条件文で切り分けたいときなども$.fnが使えます。

if ($.fn.flexslider) {
    $('.image-slider').flexslider({
    });
}

$.fnにflexsliderというプロパティが追加されているときだけ、実行されます。

以上、$.fnの使い方について、簡単ですが紹介してみました。
コンストラクタにしろ、プラグインにしろ細かく語ると大変なので、簡潔にしか説明していませんがご了承ください。

jQueryおすすめの書籍

jQueryの書籍は、古いものが多いです。ただ、jQuery自体は今も進化しています。
公式を見るのが一番良いかもしれません。
jQuery公式

jQuery最高の教科書
基本から応用まで。


コメントを残す 1

Your email address will not be published.

1 × three =


外部ファイルの関数を実行する:グローバル変数、関数と即時関数[JavaScript] | D-NET

外部ファイルの関数を実行する:グローバル変数、関数と即時関数[JavaScript] | D-NET

[…] 変数のスコープに関する話題になります。スコープを理解して、グローバル汚染の少ないコードを心がけると「理解しているな」と思ってもらえます。 ここからさらに、コンストラクタやプロトタイプなど理解していくと、変数や関数の扱いに長けたエンジニアといえると思います。 そのあたりも今後紹介できたらと思います。 関連記事で、下記ぜひもご覧ください。 jQuery.fn のfnってどういう意味? $.fnの使い方[jQuery] […]