on()函数用于为指定元素的一个或多个事件绑定事件处理函数

此外,你还可以额外传递给事件处理函数一些所需的数据。

从jQuery 1.7开始,on()函数提供了绑定事件处理程序所需的所有功能,用于统一取代以前的bind()、 delegate()、 live()等事件函数。

即使是执行on()函数之后新添加的元素,只要它符合条件,绑定的事件处理函数也对其有效。

此外,该函数可以为同一元素、同一事件类型绑定多个事件处理函数。触发事件时,jQuery会按照绑定的先后顺序依次执行绑定的事件处理函数。

要删除通过on()绑定的事件,请使用off()函数。如果要附加一个事件,只执行一次,然后删除自己,请使用one()函数。

该函数属于jQuery对象(实例)。

语法

jQuery 1.7 新增该函数。其主要有以下两种形式的用法:

用法一



1 jQueryObject.on( events [, selector ] [, data ], handler )



用法二



1 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对象本身。

重要说明

如果传递了selector参数,那么on()函数并不是为当前jQuery对象匹配的元素绑定事件处理函数,而是为它们的后代元素中符合选择器selector参数的元素绑定事件处理函数。on()函数并不是直接为这些后代元素挨个绑定事件,而是委托给当前jQuery对象的匹配元素来处理。由于DOM 2级的事件流机制,当后代元素selector触发事件时,该事件会在事件冒泡中传递给其所有的祖辈元素,当事件流传递到当前匹配元素时,jQuery会判断是哪个后代元素触发了事件,如果该元素符合选择器selector,jQuery就会捕获该事件,从而执行绑定的事件处理函数。

 

示例&说明

 

以点击事件("click")为例,以下是jQuery中事件函数的常规用法(某些函数也存在其它形式的用法,此处暂不列出):



1 // 这里的选择器selector用于指定可以触发事件的元素
 2 // 这里的选择器ancestor应是selector的祖辈元素,selector触发的事件可以被其祖辈元素在事件流中捕获,从而以"代理"的形式触发事件。
 3 
 4 // jQuery 1.0+ (1.4.3+支持参数data)
 5 $("selector").click( [ data ,] handler );
 6 
 7 // jQuery 1.0+ (1.4.3+支持参数data)
 8 $("selector").bind( "click" [, data ], handler );
 9 
10 // jQuery 1.3+ (1.4+支持参数data)
11 $("selector").live( "click" [, data ], handler );
12 
13 // jQuery 1.4.2+
14 $("ancestor").delegate( "selector", "click" [, data ], handler );
15 
16 // jQuery 1.7+
17 $("ancestor").on( "click", "selector" [, data ], handler );



请参考下面这段初始HTML代码:



1 <div id="n1">
2     <p id="n2"><span>CodePlayer</span></p>
3     <p id="n3"><span>专注于编程开发技术分享</span></p>
4     <em id="n4">http://www.365mini.com</em>
5 </div>
6 <p id="n5">Google</p>



我们为<div>中的所有<p>元素绑定点击事件:



1 // 为div中的所有p元素绑定click事件处理程序
2 // 只有n2、n3可以触发该事件
3 $("div").on("click", "p", function(){
4     // 这里的this指向触发点击事件的p元素(Element)
5     alert( $(this).text() );
6 });



如果要绑定所有的<p>元素,你可以编写如下jQuery代码:



1 //为所有p元素绑定click事件处理程序(注意:这里省略了selector参数)
2 //n2、n3、n5均可触发该事件
3 $("p").on("click", function(event){
4 // 这里的this指向触发点击事件的p元素(Element)
5     alert( $(this).text() );
6 });



此外,我们还可以同时绑定多个事件,并为事件处理函数传递一些附加的数据,我们可以通过jQuery为事件处理函数传入的参数event(Event事件对象)来进行处理:



1 var data = { id: 5, name: "张三" };
 2 
 3 // 为n5绑定mouseenter mouseleave两个事件,并为其传入附加数据data
 4 // 附加数据可以是任意类型
 5 $("body").on("mouseenter mouseleave", "#n5", data, function(event){
 6     var $me = $(this);
 7     var options = event.data; // 这就是传入的附加数据
 8     if( event.type == "mouseenter"){
 9         $me.html( "你好," + options.name + "!");      
10     }else if(event.type == "mouseleave" ){
11         $me.html( "再见!");       
12     }           
13 });



此外,即使符合条件的元素是on()函数执行后新添加,绑定事件对其依然有效。同样以初始HTML代码为例,我们可以编写如下jQuery代码:



1 // 为div中的所有p元素绑定click事件处理程序
2 // 只有n2、n3可以触发该事件
3 $("div").on("click", "p", function(event){
4     alert( $(this).text() );
5 });
6 
7 // 后添加的n6也可以触发上述click事件,因为它也是div中的p元素
8 $("#n1").append('<p id="n6">上述绑定的click事件对此元素也生效!</p>');



参数events还支持为事件类型附加额外的命名空间。当为同一元素绑定多个相同类型的事件处理函数时。使用命名空间,可以在触发事件、移除事件时限定触发或移除的范围。



1 function clickHandler(event){
 2     alert( "触发时的命名空间:[" + event.namespace + "]");
 3 }
 4 
 5 var $p = $("p");
 6 
 7 // A:为所有p元素绑定click事件,定义在foo和bar两个命名空间下
 8 $p.on( "click.foo.bar", clickHandler );
 9 
10 // B:为所有p元素绑定click事件,定义在test命名空间下
11 $p.on( "click.test", clickHandler );
12 
13 var $n2 = $("#n2");
14 
15 // 触发所有click事件
16 $n2.trigger("click"); // 触发A和B (event.namespace = "")
17 
18 // 触发定义在foo命名空间下的click事件
19 $n2.trigger("click.foo"); // 触发A (event.namespace = "foo")
20 // 触发定义在bar命名空间下的click事件
21 $n2.trigger("click.bar"); // 触发A (event.namespace = "bar")
22 // 触发同时定义在foo和bar两个命名空间下的click事件
23 $n2.trigger("click.foo.bar"); // 触发A (event.namespace = "bar.foo")
24 
25 // 触发定义在test命名空间下的click事件
26 $n2.trigger("click.test"); // 触发B (event.namespace = "test")
27 
28 // 移除所有p元素定义在foo命名空间下的click事件处理函数
29 $p.off( "click.foo" ); // 移除A
30 
31 on()函数的参数eventsMap是一个对象,可以"属性-值"的方式指定多个"事件类型-处理函数"。对应的示例代码如下:
32 
33 var data = { id: 5, name: "张三" };
34 
35 var events = {
36     "mouseenter": function(event){
37         $(this).html( "你好," + event.data.name + "!");       
38     },
39     
40     "mouseleave": function(event){
41         $(this).html( "再见!");
42     }       
43 };
44 
45 //为n5绑定mouseenter mouseleave两个事件,并为其传入附加数据data
46 $("body").on(events, "#n5", data);