デザイナーにも分かりやすいjQuery入門講座|jQueryの使い方

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

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

構文

表示されている時は隠し、隠れている時は表示する返値:jQueryオブジェクト
jQo.slideToggle( [期間] [,function] )ver1.0〜
jQo.slideToggle( [期間] [,イージング] [,function] )ver1.4.3〜
jQo.slideToggle( オプション )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オブジェクトで指定した要素が表示されている時は(slideUpの演出で)隠し、隠れている時は(slideDownの演出で)表示します。第1引数に期間を「ミリ秒」で設定することで、演出の速度を変更できます(期間を1000と設定すれば、1秒かけて要素を消します)。期間を設定しないと400ミリ秒で演出します。また、第2引数にfunctionを設定すると演出が完了した後に実行されます。

1つの処理で「表示/隠す」処理ができるため、初心者にとって非常に便利なメソッドとなっています。
v1.4.3からは期間とfunctionの間にイージングを設定して、アニメの加速度を変更できます。

解説

引数なしで利用する

slideToggleメソッドは引数なしで利用すると、400ミリ秒のアニメで演出します。隠れる時の演出はslideUpメソッドと同じで、表示される時の演出はslideDownメソッドと同じです。

サンプル(slideToggle/01.html)を開いてbody内にdiv要素とbutton要素があることを確認してください。jQueryは以下の様に記述され、buttonをクリックするとslideToggleメソッドを利用して400ミリ秒のアニメでdiv要素を表示したり隠したりします。toggleメソッドと異なりアニメを省略することはできません

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

結果として、buttonクリックするとdiv要素が表示されている時は隠し、隠れている時は表示します。

slideToggleメソッドは最初に要素を隠すとか、表示するとかは決まっていません。要素が表示されている時は隠し、隠れている時は表示するように処理します。

サンプル(slideToggle/01b.html)を開いてbody内の構成はslideToggle/01.htmlと同じ事を確認してください。jQueryは以下の様にhideメソッドを利用して最初は隠しています。

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

そのため最初div要素は隠れていますが、buttonをクリックすると要素が表示されます。

期間を設定してアニメの速度を変更する

引数に期間(ミリ秒)を設定すると、指定された時間でアニメをしながら演出します。
サンプル(slideToggle/02.html)を開いてbodyの構成がslideToggle/01.htmlと同じ事を確認して下さい。jQueryもほとんど同じで、異なるのは以下の様にslideToggleメソッドの引数に期間「1000」が設定されている点だけです。

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

結果として、buttonをクリックすると1秒(1000ミリ秒)かけてdiv要素を隠したり表示したりします。これは要素が隠れている時は表示するというslideToggleメソッドの仕様です。

コールバックの設定

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

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

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

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

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

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

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

イージングの設定

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

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

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

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

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

オプション(objectオブジェクト)の設定

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

ここではdurationプロパティとstepプロパティを利用したサンプルを紹介します。サンプル(slideToggle/05.html)を開いてbody内の構成はslideToggle/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オブジェクトは以下の様にslideToggleメソッドの引数として設定します。

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

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

関連項目

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

メモ

期間の設定について

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

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

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

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

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

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

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

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

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

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

function alertFunc(){
	var myHeight = $("div").css("height");
	alert(myHeight);
};

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

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

引数にtrueやfalseを設定する

似たような機能をもつtoggleメソッドでは引数にtrueやfalseを設定して、機能を固定することができましたが、slideToggleではできません。一応設定してみたのですが、引数を設定しないサンプルslideToggle/01.htmlと同じ扱いでした。→サンプル(slideToggle/test04.html

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