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

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

.mouseleave( )マウスカーソルが要素内(子孫要素は除く)から出た時の処理を設定

構文

マウスカーソルが要素内(子孫要素は除く)から出た時の処理を設定返値:jQueryオブジェクト
jQo.mouseleave( function )ver1.0〜
jQo.mouseleave( )ver1.0〜
jQo.mouseleave( object, function )ver1.4.3〜

機能

jQueryオブジェクトで指定した要素からマウスカーソルが出た時に引数のfunctionを実行します。引数にfunctionを設定しない場合は、要素に設定(バインド)されたfunctionを実行します。

ver1.4.3からは引数にobjectオブジェクトを設定することで、実行するfunctionにデータを渡すことができます(データはイベントオブジェクトのdataプロパティ経由で渡されます)。

mouseleaveイベントはバブリングしない(親要素にイベントが伝わらない)ため子孫要素でイベントが発生してもfunctionは実行されません。子孫要素からマウスカーソルが出た時もfunctionを実行したい場合はmouseoutメソッドを利用してください。

※以降「マウスカーソルが要素内(子孫要素は除く)にから出た」動作のことをマウスリーブと呼びます。

解説

マウスリーブで実行する処理を設定

サンプル(mouseleave/01.html)を開いてbody内にdiv要素が1つあることを確認してください。jQueryは以下の様に記述され、mouseleaveメソッドの引数にfunctionの「leaveFunc」が設定されています。

$(function () {
	$("button").mouseleave(leaveFunc);
});

mouseleaveメソッドの引数に設定するFunctionは以下の様な構文になっています。まず引数(イベントオブジェクト)を受け取ります。そしてマウスリーブしたら実行したい処理を{}の中に書きます、何かをreturnする必要はありません。イベントオブジェクトは別項にまとめてあるので、そちらを確認してください。

mouseleaveに設定するFunctionの構文
function 任意の名前(イベントオブジェクト){
 マウスリーブで実行したい処理
}

サンプルmouseleave/01.htmlで利用したleaveFuncは以下の様になっており、アラートで「mouseleave」と表示するだけです。このサンプルでは引数(イベントオブジェクト)は利用していません。

function leaveFunc(eo){
	alert("mouseleave");
}
結果として、div要素からマウスリーブするとアラートで「mouseleave」と表示されます。
イベントのfunction設定は、無名関数を利用することが多いです。→サンプル(mouseleave/01b.html

$("button").mouseleave(function(){
	alert("mouseleave");
})

他の要素に設定されたマウスリーブ時の処理を実行する

mouseleaveメソッドは引数を設定しないと、要素に設定されたマウスリーブ時の処理を実行します。
サンプル(mouseleave/02.html)を開いてbody内にbutton要素とdiv要素があることを確認してください。

続いてjQueryを確認してください。div要素に設定されたマウスリーブ時の処理はmouseleave/01b.htmlと同じですが、以下の処理が追加されています。この処理によってbuttonをクリックするとdiv要素に設定されたマウスリーブ時の処理が実行されます。

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

結果として、buttonを「クリック」するとdiv要素から「マウスリーブ」したのと同じようにアラートで「mouseleave」と表示されます。

objectオブジェクトをfunctionに渡す

第1引数にobjectオブジェクトを設定することで、実行するfunctionにデータを渡すことができます。データはイベントオブジェクトのdataプロパティを介して渡されます。サンプル(mouseleave/03.html)を開いてbody内の構成はmouseleave/01.htmlと同じ事を確認してください。

jQueryは以下の様に記述され、mouseleaveメソッドの第1引数にtestプロパティが10の値を持ったobjectオブジェクトが設定されています。このデータはイベントオブジェクト(eo)を通してfunctionに渡され、dataプロパティの値として取得できます。

$("div").mouseleave({test:10},function(eo){
	alert(eo.data.test);
})

結果として、div要素からマウスリーブすると第1引数で渡されたtestプロパティの値「10」がアラートで表示されます。

子孫要素には反応しません

mouseleaveイベントはバブリングしないため子孫要素からイベントが送られてくることはありません(つまり子孫要素には反応しません)。サンプル(mouseleave/04.html)を開いてbody内にdiv要素が入れ子になって配置(外側はoutのid属性、内側はinのid属性)されていることを確認してください。

<div id="out">
	<div id="in"></div>
</div>

jQueryは以下の様に記述され、mouseleave/01b.htmlとはセレクタが違うだけです。

$("#out").mouseleave(function(){
	alert("mouseleave")	
});

セレクタに「#out」を設定しているので、外側のdiv要素(outのid属性)からマウスリーブした際「mouseleave」と表示されますが、セレクタで指定されていない内側のdiv要素(inのid属性)にマウスリーブした際は「mouseleave」と表示されません。当たり前のようですが、mouseoutメソッドでは子孫要素から出た時もアラートが表示されます。mouseoutメソッドのサンプルと比較してみてください。
→サンプル(mouseout/04.htmloutのdiv要素からinのdiv要素に入るときも「mouseout」と表示されます。これはoutのdivからマウスアウトしたためです。

$("#out").mouseout(function(){
	alert("mouseout")	
});

イベントフローと合わせて覚えておくと良いでしょう
→参考:使い方「イベントフロー(1)」
→参考:使い方「イベントフロー(3)」

関連項目

マウスカーソルが要素内(子孫要素は除く)に入った時の処理を設定したい場合はmouseenterメソッドを利用します。