小程序开放平台

文档中心
起步
目录
配置小程序
小程序框架
框架
逻辑层
视图层
XHSML
CSS
事件系统
数据绑定
基础组件
小程序运行时
自定义组件
基础能力
开放能力
性能优化
事件回调
基础库
调试
数据分析
服务端调试

事件系统

开发
>
指南
>
小程序框架
>
视图层
>
事件系统
>
更新时间:2024-11-28 14:17:18

事件的使用方式

  • 在组件中绑定一个事件处理函数。

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

<view id="tapTest" data-hi="小红书" bindtap="tapName"> Click me! </view>
  • 在相应的 Page 定义中写上相应的事件处理函数,参数是 event。
Page({
  tapName: function(event) {
    console.log(event)
  }
})
  • 可以看到 log 出来的信息大致如下:
{
  "type":"tap",
  "timeStamp":895,
  "target": {
    "id": "tapTest",
    "dataset":  {
      "hi":"小红书"
    }
  },
  "currentTarget":  {
    "id": "tapTest",
    "dataset": {
      "hi":"小红书"
    }
  },
  "detail": {
    "x":53,
    "y":14
  },
  "touches":[{
    "identifier":0,
    "pageX":53,
    "pageY":14,
    "clientX":53,
    "clientY":14
  }],
  "changedTouches":[{
    "identifier":0,
    "pageX":53,
    "pageY":14,
    "clientX":53,
    "clientY":14
  }]
}

事件详解

事件分类

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

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

XHSML的冒泡事件列表:

类型
触发条件
touchstart手指触摸动作开始
touchmove手指触摸后移动
touchcancel手指触摸动作被打断,如来电提醒,弹窗
touchend手指触摸动作结束
tap手指触摸后马上离开
longpress手指触摸后,超过350ms再离开,如果指定了事件回调函数并触发了这个事件,tap事件将不被触发
longtap手指触摸后,超过350ms再离开(推荐使用longpress事件代替)

注:除上表之外的其他组件自定义事件如无特殊声明都是非冒泡事件,如 form 的submit事件,input 的input事件,scroll-view 的scroll事件,(详见各个组件)

普通事件绑定

事件绑定的写法类似于组件的属性,如:

<view bindtap="handleTap">
    Click here!
</view>

如果用户点击这个 view ,则页面的 handleTap 会被调用。

事件绑定函数可以是一个数据绑定,如:

<view bindtap="{{ handlerName }}">
    Click here!
</view>

此时,页面的

this.data.handlerName
必须是一个字符串,指定事件处理函数名;如果它是个空字符串,则这个绑定会失效(可以利用这个特性来暂时禁用一些事件)。

bind
后可以紧跟一个冒号,其含义不变,如
bind:tap
。

绑定并阻止事件冒泡

除

bind
外,也可以用
catch
来绑定事件。与
bind
不同,
catch
会阻止事件向上冒泡。

例如在下边这个例子中,点击 inner view 会先后调用

handleTap3
和
handleTap2
(因为tap事件会冒泡到 middle view,而 middle view 阻止了 tap 事件冒泡,不再向父节点传递),点击 middle view 会触发
handleTap2
,点击 outer view 会触发
handleTap1
。

<view id="outer" bindtap="handleTap1">
  outer view
  <view id="middle" catchtap="handleTap2">
    middle view
    <view id="inner" bindtap="handleTap3">
      inner view
    </view>
  </view>
</view>

事件的捕获阶段

捕获阶段位于冒泡阶段之前,且在捕获阶段中,事件到达节点的顺序与冒泡阶段恰好相反。需要在捕获阶段监听事件时,可以采用

capture-bind
、
capture-catch
关键字,后者将中断捕获阶段和取消冒泡阶段。

在下面的代码中,点击 inner view 会先后调用

handleTap2
、
handleTap4
、
handleTap3
、
handleTap1
。

<view id="outer" bind:touchstart="handleTap1" capture-bind:touchstart="handleTap2">
  outer view
  <view id="inner" bind:touchstart="handleTap3" capture-bind:touchstart="handleTap4">
    inner view
  </view>
</view>

如果将上面代码中的第一个

capture-bind
改为
capture-catch
,将只触发
handleTap2
。

<view id="outer" bind:touchstart="handleTap1" capture-catch:touchstart="handleTap2">
  outer view
  <view id="inner" bind:touchstart="handleTap3" capture-bind:touchstart="handleTap4">
    inner view
  </view>
</view>

事件对象

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

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

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

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

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

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

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

type

代表事件的类型。

timestamp

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

target

触发事件的源组件。

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

currentTarget

事件绑定的当前组件。

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

说明: target 和 currentTarget 可以参考上例中,点击 inner view 时,handleTap3 收到的事件对象 target 和 currentTarget 都是 inner,而 handleTap2 收到的事件对象 target 就是 inner,currentTarget 就是 middle。

dataset

在组件节点中可以附加一些自定义数据。这样,在事件中可以获取这些自定义的节点数据,用于事件的逻辑处理。

在 XHSML 中,这些自定义数据以 data- 开头,多个单词由连字符 - 连接。这种写法中,连字符写法会转换成驼峰写法,而大写字符会自动转成小写字符。如:

  • data-element-type ,最终会呈现为 event.currentTarget.dataset.elementType ;
  • data-elementType ,最终会呈现为 event.currentTarget.dataset.elementtype 。
<view data-alpha-beta="1" data-alphaBeta="2" bindtap="bindViewTap"> DataSet Test </view>
Page({
  bindViewTap:function(event){
    event.currentTarget.dataset.alphaBeta === 1 // - 会转为驼峰写法
    event.currentTarget.dataset.alphabeta === 2 // 大写会转为小写
  }
})

touches

touches 是一个数组,每个元素为一个 Touch 对象。 表示当前停留在屏幕上的触摸点。

Touch 对象

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

changedTouches

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

detail

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

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

点击事件(tap) 的detail带有的x、y属性, 同 pageX, pageY 代表距离文档左上角的距离。并且事件对象中包含 _userTap 来表示是否是用户点击事件

{
  "type": "tap",
  "timeStamp": 1705030455285,
  "target": {
    "dataset": {},
    "id": "",
    "offsetTop": 0,
    "offsetLeft": 0
  },
  "currentTarget": {
    "dataset": {},
    "id": "",
    "offsetTop": 0,
    "offsetLeft": 0
  },
  "detail": {
    "x": 87,
    "y": 64
  },
  "touches": [
    {
      "identifier": 1,
      "pageX": 87,
      "pageY": 64,
      "clientX": 87,
      "clientY": 64
    }
  ],
  "_userTap": true, // 表示用户点击
  "changedTouches": [
    {
      "identifier": 1,
      "pageX": 87,
      "pageY": 64,
      "clientX": 87,
      "clientY": 64
    }
  ]
}

注意: 基础库 < 3.83.x 的版本非

tap
事件
detail
默认也会携带
x
,
y
属性。

Tips

  • 注: v3.23.x 以前的版本,template 模板内不支持 catchtap 事件,可见 issue17