跳到主要内容

事件

事件是视图层到逻辑层的通讯方式。 事件可以将用户的行为反馈到逻辑层进行处理。 事件可以绑定在组件上,当达到触发事件,就会执行逻辑层中对应的事件处理函数。 事件对象可以携带额外信息,如 id, dataset, touches。

事件的使用方式

在组件中绑定一个事件处理函数,如 bindtap,当用户点击该组件的时候会在该页面对应的 Page 中找到相应的事件处理函数。

<view id="tap" data-name="cortana" bindtap="getName"> 获取名字 </view>

在相应的 Page 定义中写上相应的事件处理函数,参数是 event。

Page({
getName: function (e) {
console.log(e);
},
});

可以看到 log 出来的信息大致如下:

{
"type": "tap",
"timeStamp": 759,
"target": {
"id": "tap",
"dataset": {
"name": "cortana"
}
},
"currentTarget": {
"id": "tap",
"dataset": {
"name": "cortana"
}
},
"detail": {
"x": 180,
"y": 526
},
"touches": [
{
"identifier": 0,
"pageX": 180,
"pageY": 526,
"clientX": 180,
"clientY": 526
}
],
"changedTouches": [
{
"identifier": 0,
"pageX": 180,
"pageY": 526,
"clientX": 180,
"clientY": 526
}
]
}

事件分类

事件分为冒泡事件和非冒泡事件:

冒泡事件:当一个组件上的事件被触发后,该事件会向父节点传递。 非冒泡事件:当一个组件上的事件被触发后,该事件不会向父节点传递。

MXML 的冒泡事件列表:

类型触发条件
touchstart手指触摸动作开始
touchmove手指触摸后移动
touchend手指触摸动作结束
tap手指触摸后马上离开
longpress手指触摸后,超过 350ms 再离开,如果指定了事件回调函数并触发了这个事件,tap 事件将不被触发
longtap手指触摸后,超过 350ms 再离开(推荐使用 longpress 事件代替)
transitionend会在 CSS transition 或 mgtv.createAnimation 动画结束后触发
animationstart会在一个 CSS animation 动画开始时触发
animationiteration会在一个 CSS animation 一次迭代结束时触发
animationend会在一个 CSS animation 动画完成时触发
信息

除上表之外的其他组件自定义事件如无特殊声明都是非冒泡事件,如 <form/> 的 submit 事件,<input/> 的 input 事件,<scroll-view/> 的 scroll 事件。

事件绑定和冒泡

事件绑定的写法同组件的属性,以 key、value 的形式。

key 以 bind 或 catch 开头,然后跟上事件的类型,如 bindtap、catchtouchstart。 value 是一个字符串,需要在对应的 Page 中定义同名的函数。 bind 事件绑定不会阻止冒泡事件向上冒泡,catch 事件绑定可以阻止冒泡事件向上冒泡。

如在下边这个例子中,点击 [内层] 会先后调用 tap3 和 tap2 (因为 tap 事件会冒泡到 [中层],而 [中层] 阻止了 tap 事件冒泡,不再向父节点传递),点击[中层]会触发 tap2,点击[外层] 会触发 tap1。

<view id="outer" bindtap="tap1">
<!-- 外层 -->
<view id="middle" catchtap="tap2">
<!-- 中层 -->
<view id="inner" bindtap="tap3">
<!-- 内层 -->
</view>
</view>
</view>

事件的捕获阶段

捕获阶段位于冒泡阶段之前,且在捕获阶段中,事件到达节点的顺序与冒泡阶段恰好相反。需要在捕获阶段监听事件时,可以采用 capture-bind、capture-catch 关键字,后者将中断捕获阶段和取消冒泡阶段。

在下面的代码中,点击 [内层] 会先后调用 tap2、tap4、tap3、tap1。

<view id="outer" bindtap="tap1">
<!-- 外层 -->
<view id="middle" catchtap="tap2">
<!-- 中层 -->
<view id="inner" bindtap="tap3">
<!-- 内层 -->
</view>
</view>
</view>

如果将上面代码中的第一个 capture-bind 改为 capture-catch,将只触发 tap2。

<view id="outer" bind:touchstart="tap1" capture-catch:touchstart="tap2">
<!-- 外层 -->
<view id="inner" bind:touchstart="tap3" capture-bind:touchstart="tap4">
<!-- 内层 -->
</view>
</view>

事件对象

如无特殊说明,当组件触发事件时,逻辑层绑定该事件的处理函数会收到一个事件对象。

BaseEvent 基础事件对象属性列表:

属性类型说明
typeString事件类型
timeStampInteger事件生成时的时间戳
targetObject触发事件的组件的一些属性值集合
currentTargetObject当前组件的一些属性值集合

CustomEvent 自定义事件对象属性列表(继承 BaseEvent)

属性类型说明
detailObject额外的信息

TouchEvent 触摸事件对象属性列表(继承 BaseEvent)

属性类型说明
touchesArray触摸事件,当前停留在屏幕中的触摸点信息的数组
changedTouchesArray触摸事件,当前变化的触摸点信息的数组

特殊事件: <canvas/> 中的触摸事件不可冒泡,所以没有 currentTarget。

Type

代表事件的类型。

timeStamp

页面打开到触发事件所经过的毫秒数。

target

触发事件的源组件。

属性类型说明
idString事件源组件的 id
tagNameString当前组件的类型
datasetObject事件源组件上由 data- 开头的自定义属性组成的集合

特殊事件: <canvas/> 中的触摸事件不可冒泡,所以没有 currentTarget。

currentTarget

事件绑定的当前组件。

属性类型说明
idString当前组件的 id
tagNameString当前组件的类型
datasetObject当前组件上由 data- 开头的自定义属性组成的集合

说明: target 和 currentTarget 可以参考上例中,点击 [内层] 时,tap3 收到的事件对象 target 和 currentTarget 都是 内层,而 tap2 收到的事件对象 target 就是 内层,currentTarget 就是 中层。

dataset

在组件中可以定义数据,这些数据将会通过事件传递给 SERVICE。 书写方式: 以 data- 开头,多个单词由连字符-链接,不能有大写(大写会自动转成小写)如 data-element-type,最终在 event.currentTarget.dataset 中会将连字符转成驼峰 elementType。

代码示例:

<view data-alpha-beta="1" data-userName="2" bindtap="tap1"> DataSet 测试 </view>
Page({
tap1: function (event) {
event.currentTarget.dataset.userName === 1; // - 会转为驼峰写法
event.currentTarget.dataset.userName === 2; // 大写会转为小写
},
});

touches touches 是一个数组,每个元素为一个 Touch 对象(canvas 触摸事件中携带的 touches 是 CanvasTouch 数组)。 表示当前停留在屏幕上的触摸点。

Touch 对象

属性类型说明
identifierNumber触摸点的标识符
pageX, pageYNumber距离文档左上角的距离,文档的左上角为原点 ,横向为 X 轴,纵向为 Y 轴
clientX, clientYNumber距离页面可显示区域(屏幕除去导航条)左上角距离,横向为 X 轴,纵向为 Y 轴

CanvasTouch 对象

属性类型说明
identifierNumber触摸点的标识符
x, yNumber距离 Canvas 左上角的距离,Canvas 的左上角为原点 ,横向为 X 轴,纵向为 Y 轴

changedTouches

changedTouches 数据格式同 touches。 表示有变化的触摸点,如从无变有(touchstart),位置变化(touchmove),从有变无(touchend、touchcancel)。

detail 自定义事件所携带的数据,如表单组件的提交事件会携带用户的输入,媒体的错误事件会携带错误信息,详见组件定义中各个事件的定义。

点击事件的 detail 带有的 x, y 同 pageX, pageY 代表距离文档左上角的距离。