鼠标事件

在鼠标的单个动作触发多个事件时，事件的顺序是固定的，鼠标事件默认透传。

说明：

  • 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
  • 目前仅支持通过外接鼠标触发。

onHover

onHover(event: (isHover: boolean, event: HoverEvent) => void): T

鼠标进入或退出组件时触发该回调。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
isHover boolean 是 表示鼠标是否悬浮在组件上，鼠标进入时为true, 退出时为false。
event10+ HoverEvent 是 设置阻塞事件冒泡属性。

返回值：

类型 说明
T 返回当前组件。

onMouse

onMouse(event: (event: MouseEvent) => void)

当前组件被鼠标按键点击时或者鼠标在组件上悬浮移动时，触发该回调。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
onMouse MouseEvent 是 返回触发事件时的时间戳、鼠标按键、动作、鼠标位置在整个屏幕上的坐标和相对于当前组件的坐标。

MouseEvent对象说明

名称 属性类型 描述
x number 鼠标位置相对于当前组件左上角的x轴坐标。
y number 鼠标位置相对于当前组件左上角的y轴坐标。
button MouseButton 鼠标按键。
action MouseAction 鼠标动作。
stopPropagation () => void 阻塞事件冒泡。
timestamp number 事件时间戳。触发事件时距离系统启动的时间间隔，单位纳秒。
target EventTarget 触发事件的元素对象显示区域。
source SourceType 事件输入设备。
windowX10+ number 鼠标位置相对于应用窗口左上角的x轴坐标。
windowY10+ number 鼠标位置相对于应用窗口左上角的y轴坐标。
displayX10+ number 鼠标位置相对于应用屏幕左上角的x轴坐标。
displayY10+ number 鼠标位置相对于应用屏幕左上角的y轴坐标。
screenX(deprecated) number 鼠标位置相对于应用窗口左上角的x轴坐标。
从API verdion 10开始不再维护，建议使用windowX代替。
screenY(deprecated) number 鼠标位置相对于应用窗口左上角的y轴坐标。
从API verdion 10开始不再维护，建议使用windowY代替。

HoverEvent10+对象说明

名称 属性类型 描述
stopPropagation () => void 阻塞事件冒泡。

示例

// xxx.ets
@Entry
@Component
struct MouseEventExample {
  @State hoverText: string = 'no hover';
  @State mouseText: string = '';
  @State action: string = '';
  @State mouseBtn: string = '';
  @State color: Color = Color.Blue;

  build() {
    Column({ space: 20 }) {
      Button(this.hoverText)
        .width(180).height(80)
        .backgroundColor(this.color)
        .onHover((isHover: boolean, event: HoverEvent) => {
          // 通过onHover事件动态修改按钮在是否有鼠标悬浮时的文本内容与背景颜色
          if (isHover) {
            this.hoverText = 'hover';
            this.color = Color.Pink;
          } else {
            this.hoverText = 'no hover';
            this.color = Color.Blue;
          }
        })
      Button('onMouse')
        .width(180).height(80)
        .onMouse((event: MouseEvent):void => {
          if(event){
            switch (event.button) {
              case MouseButton.None:
                this.mouseBtn = 'None';
                break;
              case MouseButton.Left:
                this.mouseBtn = 'Left';
                break;
              case MouseButton.Right:
                this.mouseBtn = 'Right';
                break;
              case MouseButton.Back:
                this.mouseBtn = 'Back';
                break;
              case MouseButton.Forward:
                this.mouseBtn = 'Forward';
                break;
              case MouseButton.Middle:
                this.mouseBtn = 'Middle';
                break;
            }
            switch (event.action) {
              case MouseAction.Hover:
                this.action = 'Hover';
                break;
              case MouseAction.Press:
                this.action = 'Press';
                break;
              case MouseAction.Move:
                this.action = 'Move';
                break;
              case MouseAction.Release:
                this.action = 'Release';
                break;
            }
            this.mouseText = 'onMouse:\nButton = ' + this.mouseBtn +
            '\nAction = ' + this.action + '\nXY=(' + event.x + ',' + event.y + ')' +
            '\nwindowXY=(' + event.windowX + ',' + event.windowY + ')';
          }
        })
      Text(this.mouseText)
    }.padding({ top: 30 }).width('100%')
  }
}

示意图：

鼠标悬浮时改变文本内容与背景颜色：

mouse

鼠标点击时：

mouse1