on() 函數用於為指定元素的一個或多個事件綁定事件處理函數。
此外,你還可以額外傳遞給事件處理函數一些所需的數據。
從jQuery 1.7開始,on()
函數提供了綁定事件處理程序所需的所有功能,用於統一取代以前的 bind()、 delegate()、 live() 等事件函數。
即使是執行 on() 函數之后新添加的元素,只要它符合條件,綁定的事件處理函數也對其有效。
此外,該函數可以為同一元素、同一事件類型綁定多個事件處理函數。觸發事件時,jQuery會按照綁定的先后順序依次執行綁定的事件處理函數。
要刪除通過on()
綁定的事件,請使用off()函數。如果要附加一個事件,只執行一次,然后刪除自己,請使用one()函數。
該函數屬於jQuery
對象(實例)。
語法
jQuery 1.7 新增該函數。其主要有以下兩種形式的用法:
用法一:
jQueryObject.on( events [, selector ] [, data ], handler )
用法二:
jQueryObject.on( eventsMap [, selector ] [, data ] )
參數
參數 | 描述 |
---|---|
events | String類型一個或多個用空格分隔的事件類型和可選的命名空間,例如"click"、"focus click"、"keydown.myPlugin"。 |
eventsMap | Object類型一個Object對象,其每個屬性對應事件類型和可選的命名空間(參數events ),屬性值對應綁定的事件處理函數(參數handler )。 |
selector | 可選/String類型一個jQuery選擇器,用於指定哪些后代元素可以觸發綁定的事件。如果該參數為null 或被省略,則表示當前元素自身綁定事件(實際觸發者也可能是后代元素,只要事件流能到達當前元素即可)。 |
data | 可選/任意類型觸發事件時,需要通過event.data傳遞給事件處理函數的任意數據。 |
handler | Function類型指定的事件處理函數。 |
關於參數 events 中可選的命名空間,請參考最下面的示例代碼。
關於參數selector
,你可以簡單地理解為:如果該參數等於null
或被省略,則為當前匹配元素綁定事件;否則就是為當前匹配元素的后代元素中符合selector
選擇器的元素綁定事件。
參數handler
中的this
指向當前匹配元素的后代元素中觸發該事件的DOM元素。如果參數selector
等於null
或被省略,則this
指向當前匹配元素(也就是該元素)。
on() 還會為handler
傳入一個參數:表示當前事件的Event對象。
參數handler
的返回值與DOM原生事件的處理函數返回值作用一致。例如"submit"(表單提交)事件的事件處理函數返回false
,可以阻止表單的提交。
如果事件處理函數handler
僅僅只為返回false
值,可以直接將handler
設為false
。
返回值
on()
函數的返回值為jQuery類型,返回當前jQuery對象本身。
重要說明:
on()
函數並不是為當前jQuery對象匹配的元素綁定事件處理函數,而是為它們的后代元素中符合選擇器selector
參數的元素綁定事件處理函數。on()
函數並不是直接為這些后代元素挨個綁定事件,而是委托給當前jQuery對象的匹配元素來處理。由於DOM 2級的事件流機制,當后代元素selector
觸發事件時,該事件會在事件冒泡中傳遞給其所有的祖輩元素,當事件流傳遞到當前匹配元素時,jQuery會判斷是哪個后代元素觸發了事件,如果該元素符合選擇器selector
,jQuery就會捕獲該事件,從而執行綁定的事件處理函數。
示例&說明
以點擊事件("click")為例,以下是jQuery中事件函數的常規用法(某些函數也存在其它形式的用法,此處暫不列出):
// 這里的選擇器selector用於指定可以觸發事件的元素 // 這里的選擇器ancestor應是selector的祖輩元素,selector觸發的事件可以被其祖輩元素在事件流中捕獲,從而以"代理"的形式觸發事件。 // jQuery 1.0+ (1.4.3+支持參數data) $("selector").click( [ data ,] handler ); // jQuery 1.0+ (1.4.3+支持參數data) $("selector").bind( "click" [, data ], handler ); // jQuery 1.3+ (1.4+支持參數data) $("selector").live( "click" [, data ], handler ); // jQuery 1.4.2+ $("ancestor").delegate( "selector", "click" [, data ], handler ); // jQuery 1.7+ $("ancestor").on( "click", "selector" [, data ], handler );
請參考下面這段初始HTML代碼:
<div id="n1"> <p id="n2"><span>CodePlayer</span></p> <p id="n3"><span>專注於編程開發技術分享</span></p> <em id="n4">http://www.365mini.com</em> </div> <p id="n5">Google</p>
我們為<div>中的所有<p>元素綁定點擊事件:
// 為div中的所有p元素綁定click事件處理程序 // 只有n2、n3可以觸發該事件 $("div").on("click", "p", function(){ // 這里的this指向觸發點擊事件的p元素(Element) alert( $(this).text() ); });
運行代碼(其他代碼請自行復制到演示頁面運行)
如果要綁定所有的<p>元素,你可以編寫如下jQuery代碼:
//為所有p元素綁定click事件處理程序(注意:這里省略了selector參數) //n2、n3、n5均可觸發該事件 $("p").on("click", function(event){ // 這里的this指向觸發點擊事件的p元素(Element) alert( $(this).text() ); });
此外,我們還可以同時綁定多個事件,並為事件處理函數傳遞一些附加的數據,我們可以通過jQuery為事件處理函數傳入的參數event
(Event事件對象)來進行處理:
var data = { id: 5, name: "張三" }; // 為n5綁定mouseenter mouseleave兩個事件,並為其傳入附加數據data // 附加數據可以是任意類型 $("body").on("mouseenter mouseleave", "#n5", data, function(event){ var $me = $(this); var options = event.data; // 這就是傳入的附加數據 if( event.type == "mouseenter"){ $me.html( "你好," + options.name + "!"); }else if(event.type == "mouseleave" ){ $me.html( "再見!"); } });
此外,即使符合條件的元素是on()
函數執行后新添加,綁定事件對其依然有效。同樣以初始HTML代碼為例,我們可以編寫如下jQuery代碼:
// 為div中的所有p元素綁定click事件處理程序 // 只有n2、n3可以觸發該事件 $("div").on("click", "p", function(event){ alert( $(this).text() ); }); // 后添加的n6也可以觸發上述click事件,因為它也是div中的p元素 $("#n1").append('<p id="n6">上述綁定的click事件對此元素也生效!</p>');
參數events
還支持為事件類型附加額外的命名空間。當為同一元素綁定多個相同類型的事件處理函數時。使用命名空間,可以在觸發事件、移除事件時限定觸發或移除的范圍。
function clickHandler(event){ alert( "觸發時的命名空間:[" + event.namespace + "]"); } var $p = $("p"); // A:為所有p元素綁定click事件,定義在foo和bar兩個命名空間下 $p.on( "click.foo.bar", clickHandler ); // B:為所有p元素綁定click事件,定義在test命名空間下 $p.on( "click.test", clickHandler ); var $n2 = $("#n2"); // 觸發所有click事件 $n2.trigger("click"); // 觸發A和B (event.namespace = "") // 觸發定義在foo命名空間下的click事件 $n2.trigger("click.foo"); // 觸發A (event.namespace = "foo") // 觸發定義在bar命名空間下的click事件 $n2.trigger("click.bar"); // 觸發A (event.namespace = "bar") // 觸發同時定義在foo和bar兩個命名空間下的click事件 $n2.trigger("click.foo.bar"); // 觸發A (event.namespace = "bar.foo") // 觸發定義在test命名空間下的click事件 $n2.trigger("click.test"); // 觸發B (event.namespace = "test") // 移除所有p元素定義在foo命名空間下的click事件處理函數 $p.off( "click.foo" ); // 移除A
on()
函數的參數eventsMap
是一個對象,可以"屬性-值"的方式指定多個"事件類型-處理函數"。對應的示例代碼如下:
var data = { id: 5, name: "張三" }; var events = { "mouseenter": function(event){ $(this).html( "你好," + event.data.name + "!"); }, "mouseleave": function(event){ $(this).html( "再見!"); } }; //為n5綁定mouseenter mouseleave兩個事件,並為其傳入附加數據data $("body").on(events, "#n5", data);