jQuery API の off( events, fn ) は、「events」に指定したイベントのイベントハンドラ「fn」を、マッチした要素から取り除くメソッド。
記述方法
jQuery( セレクター ) . off( イベントタイプ, イベントハンドラ );
「セレクター」にマッチした要素から、「イベントタイプ」に指定したイベントの「イベントハンドラ」を取り除く。
引数
- events / イベントタイプ
「click」や「mouseover」などのイベントタイプを文字列で指定。
- fn / イベントハンドラ
取り除きたいイベントハンドラを指定。
実装例(サンプル)
- このリストに追加
実装例(サンプル)の動作について
- 「項目追加」ボタンのクリックイベント、マウスオーバーイベント、マウスアウトイベントが発生すると、ボタンの下のリストに項目を追加する。
- 「イベントハンドラを追加」ボタンをクリックする度に、項目を追加するイベントハンドラを「項目追加」ボタンのクリックイベント、マウスオーバーイベント、マウスアウトイベントに追加する。
- 「クリックイベントのイベントハンドラを取り除く」ボタンをクリックすると、「項目追加」ボタンのクリックイベントのイベントハンドラを取り除く。
- 「マウスオーバーイベントのイベントハンドラを取り除く」ボタンをクリックすると、「項目追加」ボタンのマウスオーバーイベントのイベントハンドラを取り除く。
- 「マウスアウトイベントのイベントハンドラを取り除く」ボタンをクリックすると、「項目追加」ボタンのマウスアウトイベントのイベントハンドラを取り除く。
- 「マウスオーバーイベントとマウスアウトイベントのイベントハンドラを取り除く」ボタンをクリックすると、「項目追加」ボタンのマウスオーバーイベントとマウスアウトイベントのイベントハンドラを取り除く。
実装例(サンプル)のソースコード
JavaScript
<script>
<!--
jQuery( function() {
var count = 1;
function sampleEventHandler() {
jQuery( "#sample-ol" ).append( "<li>追加項目" + count++ + "。</li>" );
}
jQuery( "#sample-bind" ).on( "click", function() {
jQuery( "#sample-button" ).on( "click mouseover mouseout", sampleEventHandler );
} ).click();
jQuery( "#sample-unbind-click" ).on( "click", function() {
jQuery( "#sample-button" ).off( "click", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseover" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseover", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseout" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseout", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseover-mouseout" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseover mouseout", sampleEventHandler );
} );
} );
// -->
</script>
<!--
jQuery( function() {
var count = 1;
function sampleEventHandler() {
jQuery( "#sample-ol" ).append( "<li>追加項目" + count++ + "。</li>" );
}
jQuery( "#sample-bind" ).on( "click", function() {
jQuery( "#sample-button" ).on( "click mouseover mouseout", sampleEventHandler );
} ).click();
jQuery( "#sample-unbind-click" ).on( "click", function() {
jQuery( "#sample-button" ).off( "click", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseover" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseover", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseout" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseout", sampleEventHandler );
} );
jQuery( "#sample-unbind-mouseover-mouseout" ).on( "click", function() {
jQuery( "#sample-button" ).off( "mouseover mouseout", sampleEventHandler );
} );
} );
// -->
</script>
HTML
<button id="sample-button">項目追加</button><br />
<button id="sample-bind">「項目追加」ボタンにイベントハンドラを追加</button><br />
<button id="sample-unbind-click">「項目追加」ボタンのクリックイベントのイベントハンドラを取り除く</button><br />
<button id="sample-unbind-mouseover">「項目追加」ボタンのマウスオーバーイベントのイベントハンドラを取り除く</button><br />
<button id="sample-unbind-mouseout">「項目追加」ボタンのマウスアウトイベントのイベントハンドラを取り除く</button>
<button id="sample-unbind-mouseover-mouseout">「項目追加」ボタンのマウスオーバーイベントとマウスアウトイベントのイベントハンドラを取り除く</button>
<ol id="sample-ol">
<li>このリストに追加</li>
</ol>
<button id="sample-bind">「項目追加」ボタンにイベントハンドラを追加</button><br />
<button id="sample-unbind-click">「項目追加」ボタンのクリックイベントのイベントハンドラを取り除く</button><br />
<button id="sample-unbind-mouseover">「項目追加」ボタンのマウスオーバーイベントのイベントハンドラを取り除く</button><br />
<button id="sample-unbind-mouseout">「項目追加」ボタンのマウスアウトイベントのイベントハンドラを取り除く</button>
<button id="sample-unbind-mouseover-mouseout">「項目追加」ボタンのマウスオーバーイベントとマウスアウトイベントのイベントハンドラを取り除く</button>
<ol id="sample-ol">
<li>このリストに追加</li>
</ol>