您的浏览器过于古老 & 陈旧。为了更好的访问体验, 请 升级你的浏览器
Ready 发布于2014年09月05日 08:31

原创 jQuery.triggerHandler() 函数详解

100 次浏览 读完需要≈ 11 分钟

内容目录

triggerHandler()函数用于在每个匹配元素上触发指定类型的事件

此外,你还可以在触发事件时为事件处理函数传入额外的参数。

该函数的作用于trigger()函数相似,但triggerHandler()函数具有以下例外情况:

  • triggerHandler()不会触发执行元素的默认行为(例如链接click事件默认的跳转行为,表单submit事件默认的提交行为)。
  • triggerHandler()触发事件只针对jQuery对象中的第一个匹配元素。
  • triggerHandler()触发的事件不会在DOM树中冒泡,因此事件不会冒泡传递到它的任何祖辈元素。
  • triggerHandler()的返回值是对应事件处理函数的返回值,而不是当前jQuery对象本身。

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

语法

jQuery 1.2 新增该函数。

jQueryObject.triggerHandler( events [, extraArguments ] )

参数

参数 描述
events String类型指定的事件类型和可选的命名空间,例如"click"、"focus"、"keydown.myPlugin"。
extraArguments 可选/Object类型为事件处理函数传入的额外参数。如果要传入多个参数,请以数组方式传入。

triggerHandler()函数会为触发执行的事件处理函数传入一个默认参数,也就是表示当前事件的Event对象

参数extraArguments用于为事件处理函数传入更多额外的参数。如果extraArguments是数组形式,则每个元素都将充当函数的参数。

返回值

triggerHandler()函数的返回值为任意类型,返回触发执行的事件处理函数的返回值。

示例&说明

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

<input id="btn1" type="button" value="点击1" />
<input id="btn2" type="button" value="点击2" />
<a id="a1" href="#">CodePlayer</a>
<div id="log"></div>

首先,我们为上述button和<a>元素绑定事件,然后使用triggerHandler()函数直接触发事件,相应的代码如下:

var $log = $("#log");

function handler( event, arg1, arg2 ){
	var html = '<br>触发元素#' + this.id + '的[' + event.type +']事件,额外的函数参数为:' + arg1 + ', ' + arg2;
	$log.append( html );
}

var $buttons = $(":button");

// 为所有button元素的click事件绑定事件处理函数
$buttons.bind( "click", handler );

// 为所有a元素的click、mouseover、mouseleave事件绑定事件处理函数
$("a").bind( "click mouseover mouseleave", handler );


// 触发btn1的click事件
// 虽然$buttons匹配两个button元素,但只会触发第一个匹配元素的click事件
$buttons.triggerHandler("click");
/*(追加文本)
触发元素#btn1的[click]事件,额外的函数参数为:undefined, undefined
*/


$("#btn2").triggerHandler("click", "CodePlayer");
/*(追加文本)
触发元素#btn2的[click]事件,额外的函数参数为:CodePlayer, undefined
*/

// arg1 = "张三", arg2 = 20
$("a").triggerHandler("mouseover", ["张三", 20 ] );
/*(追加文本)
触发元素#a1的[mouseover]事件,额外的函数参数为:张三, 20
*/


$("a").triggerHandler("mouseleave", { name: "张三", age: 18 } );
/*(追加文本)
触发元素#a1的[mouseleave]事件,额外的函数参数为:[object Object], undefined
*/

运行代码(其他代码请自行复制到演示页面运行)

triggerHandler()函数还可以根据传入事件处理函数的Event对象,来触发对应的事件。

var $btn1 = $("#btn1");

// 为btn1元素的click事件绑定事件处理函数
$btn1.bind( "click", function(event){
	alert("click1");	
});

// 为btn1元素的click事件绑定事件处理函数
// 如果传入了一个有效的额外参数,则再次触发click
$btn1.bind( "click", function(event, arg1){
	alert("click2");
	if(arg1)
		$(this).triggerHandler( event );
});

// $btn1.triggerHandler( "click" ); // 调用一次click1、调用一次click2

$btn1.triggerHandler( "click", true ); // 调用两次click1、调用两次click2

此外,triggerHandler()函数还可以只触发包含指定定命名空间的事件(1.4.3+才支持命名空间)。

function A( event ){
	alert( 'A' );
}
function B( event ){
	alert( 'B' );
}
function C( event ){
	alert( 'C' );
}

var $btn1 = $("#btn1");

// 为btn1元素的click事件绑定事件处理函数
$btn1.bind( "click.foo.bar", A );
$btn1.bind( "click.test.foo", B );
$btn1.bind( "click.test", C );


// 触发btn1的click事件,不限定命名空间
$btn1.triggerHandler("click"); // 触发A、B、C

// 触发btn1的包含命名空间foo的click事件
$btn1.triggerHandler("click.foo"); // 触发A、B

// 触发btn1的包含命名空间test的click事件
$btn1.triggerHandler("click.test"); // 触发B、C

// 触发btn1的同时包含命名空间foo和test的click事件
$btn1.triggerHandler("click.foo.test"); // 触发B
  • CodePlayer技术交流群1
  • CodePlayer技术交流群2

0 条评论

撰写评论

打开导航菜单