初心者向けのjQuery入門講座|デザイナー向けのJavaScriptライブラリ
このエントリーをはてなブックマークに追加
索引
Core：コアとなる仕組み
Selectors：セレクタ
Attributes：属性
Traversing：対象の変更
Manipulation：操作
CSS：スタイルシート
Events：イベント
Effects：演出効果
Ajax：xml等との連携
Utilities：ユーティリティ
Data：データ
Miscellaneous：諸々
Deferred：処理管理
Callbacks：コールバック
Internals：内部処理

.toggle( )表示されている時は隠し、隠れている時は表示する

構文

表示されている時は隠し、隠れている時は表示する返値：jQueryオブジェクト
jQo.toggle( [期間] [,function] )ver1.0〜
jQo.toggle( true/false)ver1.3〜
jQo.toggle( [期間] [,イージング] [,function] )ver1.4.3〜
jQo.toggle( オプション )ver1.0〜
上記構文のオプションはobjectオブジェクトで指定します。利用できるプロパティは以下の通りです。
・duration：目的の値までの期間をミリ秒で指定
・easing：アニメの加速度のタイプを指定
・queue：アニメをキューに追加するか以下かを指定
・step：アニメの期間に連続して実行するfunctionを指定
・complete：アニメの完了時に実行するfunctionを指定
・specialEasing：プロパティ（幅や高さなど）毎に個別のイージングを設定します。v1.4〜
以下はv1.8で追加されたDeferredに合わせて追加されました（functionの引数にpromiseオブジェクトがある）
・start：アニメが開始された時に実行するfunctionを指定
・progress：アニメの期間に連続して実行するfunctionを指定
・done：アニメが正常終了した時に実行するfunctionを指定
・fail：アニメが異常終了した時（stopされた時）に実行するfunctionを指定
・always：アニメの終了した時（正常/異常にかかわらず）に実行するfunctionを指定

機能

jQueryオブジェクトで指定した要素が表示されている時は（hideメソッドの演出で）隠し、隠れている時は（showメソッドの演出で）表示します。第1引数に期間を「ミリ秒」で設定することで、演出の速度を変更できます（期間を1000と設定すれば、1秒かけて要素を消します）。期間を設定しないとアニメ無しで演出します。また、第2引数にfunctionを設定すると演出が完了した後に実行されます。

1つの処理で「表示/隠す」処理ができるため初心者にとって非常に便利なメソッドなのですが、演出が「拡大/縮小＋フェード」と少々過剰なため、意外と利用機会はありません。似たような機能のslideToggleメソッドのほうが良いかもしれません。

v1.3からは引数にtrue/falseを設定し、showメソッドかhideメソッドの機能に固定することができます。
v1.4.3からは期間とfunctionの間にイージングを設定して、アニメの加速度を変更できます。

解説

引数なしで利用する

toggleメソッドは引数なしで利用すると、アニメの演出なしに演出します。
サンプル（toggle/01.html）を開いてbody内にdiv要素とbutton要素があることを確認してください。jQueryは以下の様に記述され、buttonをクリックするとtoggleメソッドを利用してアニメの演出なしにdiv要素を表示したり隠したりします。 

$("button").click(function(){
	$("div").toggle();
});

結果として、buttonクリックする度にdiv要素が消えたり表示されます。

期間を設定してアニメの演出にする

引数に期間（ミリ秒）を設定すると、指定された時間でアニメをしながら演出します。隠れる時の演出はhideメソッドと同じで、表示される時の演出はshowメソッドと同じです。ちょっと過剰演出気味なので、あまり使いどころはないと思います。

サンプル（toggle/02.html）を開いてbodyの構成がtoggle/01.htmlと同じ事を確認して下さい。jQueryもほとんど同じで、異なるのは以下の様にtoggleメソッドの引数に期間「1000」が設定されている点だけです。 

$("button").click(function(){
	$("div").toggle(1000);
});

結果として、buttonクリックする度に1秒（1000ミリ秒）かけてdiv要素が縮小しながらフェードアウしたり、拡大しながらフェードインします。

コールバックの設定

第2引数にfunctionを設定することで、演出の後にfunctionを実行することができます。
サンプル（toggle/03.html）を開いてbody内の構成がtoggle/02.htmlと同じ事を確認してください。jQueryは少し変更されています。まずはtoggleメソッドを確認して下さい。以下の様に第2引数にfunction「alertFunc」が設定されています。 

$("button").click(function(){
	$("div").toggle(1000, alertFunc);
});

そしてalertFuncは、以下の様にアラートで「Animation complete.」と表示するだけです。 

function alertFunc(){
	alert("Animation complete.")
};

結果として、div要素が隠れた後や表示された後で「Animation complete.」とアラートが表示されます。「表示/隠す」で個別のfunctionを設定することはできません。

functionは無名関数を利用して、直接設定することができます。→サンプル（toggle/03b.html） 

$("div").toggle(1000, function (){
	alert("Animation complete.")
});

演出の固定

v1.3から引数にtrueを設定することで「表示」、falseを設定することで「隠す」と機能を固定することができます。サンプルサンプル（toggle/04.html）を開いてbody内にdiv要素が1つと、2つのbutton要素があることを確認して下さい。button要素にはそれぞれ「show」と「hide」と個別のid属性が設定されています。 

<button id="show">show</button>
<button id="hide">hide</button>
<div></div>

jQueryは以下の様に記述され、id属性が「show」のbuttonがクリックされた時は、引数にtrueを設定したtoggleメソッドが実行されます。また、id属性が「hide」のbuttonがクリックされた時は、引数にfalseを設定したtoggleメソッドが実行されます。 

$("button#show").click(function(){
	$("div").toggle(true);
});		
$("button#hide").click(function(){
	$("div").toggle(false);
});

結果として、hideのbuttonをクリックしたらdiv要素が隠れ、showのbuttonをクリックしたらdiv要素が表示されます。たぶんフラグや条件式によって処理を変更する時に利用する構文なのだと思います。

イージングの設定

v1.4.3からはtoggleメソッドの第2引数にイージングの設定ができるようになりました。jQueryが利用できるイージングは「swing」と「linear」の2種類しかありません。デフォルトは「swing」です。イージングの種類はプラグインを追加することで増やすことができます。→プラグイン「イージングの追加」

サンプル（toggle/05.html）を開いてbody内の構成がtoggle/02.htmlと同じ事を確認してください。jQueryもほとんどtoggle/02.htmlと同じで、異なるのは以下の様に第2引数にイージング「linear」が追加された点だけです。 

$("button").click(function(){
	$("div").toggle(1000, "linear");
});

結果として、div要素をクリックすると「等速」でアニメが再生されます。違いが分かりにくいので、イージングの「swing」と「linear」を比較できるサンプルを作成しました。

サンプル（toggle/05b.html）ではbutton要素をクリックすると、id属性がswingと設定された方は「swing」のイージング、id属性がlinearと設定された方は「linear」のイージングで演出されます。あまり違いは分からないかもしれませんが、linearは等速で演出し、swingは徐々に加速後、徐々に減速します。

オプション（objectオブジェクト）の設定

引数にobjectオブジェクトを設定することで様々な処理が可能になります。利用できるプロパティはanimate(prop,option)メソッドと同じなので、詳細はそちらを参照してください。

ここではdurationプロパティとstepプロパティを利用したサンプルを紹介します。サンプル（toggle/06.html）を開いてbody内の構成はtoggle/01.htmlと同じことを確認してください。jQueryでは、まず以下の部分を確認してください。 

testObj = new Object();
testObj.duration = 3000;
testObj.progress = function(){
	var myHeight = $("div").height();
	$("div").text(myHeight)	
}

1行目でobjectオブジェクトを作成し、2行目でdurationプロパティを設定しています。ここでは3000（ミリ秒）を設定しているので3秒かけて演出します。そして3〜6行目ではprogressプロパティを設定しています。このプロパティにfunctionを代入しておくと演出をしている間に実行したい処理を設定できます。このサンプルではdiv要素の高さを取得し、それをdiv要素内に表示しています。

そして作成したobjectオブジェクトは以下の様にtoggleメソッドの引数として設定します。 

$("button").click(function(){
	$("div").toggle(testObj);
});

結果として、buttonをクリックすると3秒かけてdiv要素が消えていきますが、progressプロパティに設定した処理によりdiv要素内に刻々とdiv要素の高さが表示されます。再びbuttonをクリックして表示する場合にもdiv要素に高さが表示されます。

関連項目

要素を隠したい場合はhideメソッドを利用します。
隠れた要素を再び表示したい場合はshowメソッドを利用します。

イベントにも全く同じ綴りでtoggleイベントがあります。構文が違うので混同することはないと思いますが、確認して機能の違いを覚えておきましょう。

メモ

期間の設定について

第1引数の期間を設定するところでは「slow」「fast」といったキーワードも利用することができます（fastは200ミリ秒、slowは600ミリ秒）。サンプル（toggle/test01.html）では以下の様に引数に「slow」を設定しています（文字列なのでクォートを忘れずに）。 

$("button").click(function(){
	$("div").toggle("slow");
});

結果として、buttonをクリックすると「ゆっくりめ」にアニメします。

複数の対象にも対応しています

セレクタに一致する要素が複数あっても、toggleメソッドでまとめて隠すことができます。
サンプル（toggle/test02.html）を開いてjQueryがtoggle/02.htmlと同じ事を確認して下さい。body内の構成は変更され、div要素が3つに増えています。 

<body>
	<button>click</button>
	<div></div>
	<div></div>
	<div></div>
</body>

結果として、buttonをクリックすると全てのdiv要素が表示されたり隠れます。

表示した時と隠れた時で異なるコールバック（function）を実行したいのですが...

表示した時と隠れた時で異なるfunctionを実行したいのですが、そのような構文はありません。なのでfunction内で判断するしかないと思うのですが、そこでも予想外の事態になっています。

サンプル（toggle/test03.html）を開いてbody内の構成がtoggle/03.htmlと同じ事を確認して下さい。jQUeryもほとんど同じなのですが、以下の様にコールバックに設定したalertFuncを以下の様に変更しています。 

function alertFunc(){
	var myWidth = $("div").css("width");
	alert(myWidth);
};

ポイントは2行目でcssメソッドを利用してdiv要素の幅を取得している部分です。これで隠れた後では「0px」と表示されると思ったのですが、そうはなりませんでした...。

この方法がダメだとすると、どのように判断したらよいのでしょう？。フラグを設定するのもtoggleメソッドの使い勝手を損なう気がしますし...。