Event.cancelBubble - 伝播を止める
cancelBubbleは、Eventのプロパティです。trueを代入すると、現在のイベントで伝播を終了させます。このプロパティは利用できなくなる予定です。代わりにstopPropagation()を利用して下さい。
このAPIは非推奨です。新しくコードに加えず、代わりの手段を探して下さい。
概要
- 名前
- cancelBubble
- 所属
- Event
- IDL
attribute boolean cancelBubble; // historical alias of .stopPropagation
- 仕様書
- https://dom.spec.whatwg.org/#dom-event-cancelbubble
説明
イベントの伝播がここで終了する場合はtrue、違うならfalseを返します。trueを代入すると、伝播を終了させます。
デモ
Event.cancelBubbleのデモです。button要素とdiv要素(#hoge)にイベントを設定しました。一番上のbutton要素はイベント内でプロパティにtrueを代入して伝播を止めるため、その後に予定されているバブリングフェイズでのdiv要素のイベントが発生しません。
<!-- このコードは編集できます。 -->
<!DOCTYPE html>
<html>
<head>
<style>
div#hoge {
background-color: #fffff0 ;
padding: 24px ;
}
div#result {
white-space: pre-wrap ;
}
</style>
</head>
<body>
<div id="hoge">
<p><button id="run1">実行 (伝播を止める)</button></p>
<p><button id="run2">実行 (伝播を止めない)</button></p>
</div>
<p><button id="clear">削除</button></p>
<hr>
<div id="result"></div>
<script>
/** try it! **/
var element1 = document.getElementById( "run1" ) ;
var element2 = document.getElementById( "run2" ) ;
var callbackFn = function ( event ) {
if ( event.target === element1 ) event.cancelBubble = true ;
resultElement.appendChild( new Text( "currentTarget: " + event.currentTarget + "(#" + event.currentTarget.id + ")" + "\n" ) ) ;
resultElement.appendChild( new Text( "target: " + event.target + "\n→\n" ) ) ;
} ;
element1.addEventListener( "click", callbackFn ) ; // button要素
element2.addEventListener( "click", callbackFn ) ; // button要素
document.getElementById( "hoge" ).addEventListener( "click", callbackFn, false ) ; // div要素
/** try it! **/
var resultElement = document.getElementById( "result" ) ;
document.getElementById( "clear" ).onclick = function ( event ) {
event.stopPropagation() ;
resultElement.innerHTML = "" ;
}
</script>
</body>
</html>
サポート状況
Chrome | Firefox | Safari | Edge | IE | Opera | iOS Safari | Android |
---|---|---|---|---|---|---|---|
● 19+ | ● 5+ | ● 6.0+ | ● | ● | ● | ● 6.0+ | ● 4.3+ |
関連記事
- 指定文字を置換、削除する
- 文字列の中の指定した部分を置換したり削除します。
- JavaScript
- Google Maps JavaScript APIの使い方を、初心者にも分かるようにまとめています。
- Eventリファレンス
- WHATWGやW3Cで定義されているEventの仕様を、サンプルコードやデモ付きでまとめています。
- class属性値を取得、変更する
- 要素のclass属性値を取得、変更、確認する方法をまとめています。