• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2
3
4
5# 鼠标事件
6
7在鼠标的单个动作触发多个事件时，事件的顺序是固定的，鼠标事件默认透传。
8
9>  **说明：**
10>
11>  从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
12
13
14## 事件
15
16| 名称                                                         | 支持冒泡 | 描述                                                         |
17| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
18| onHover(event:&nbsp;(isHover?:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 否       | 鼠标进入或退出组件时触发该回调。<br/>isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true,&nbsp;退出时为false。 |
19| onMouse(event:&nbsp;(event?:&nbsp;MouseEvent)&nbsp;=&gt;&nbsp;void) | 是       | 当前组件被鼠标按键点击时或者鼠标在组件上悬浮移动时，触发该回调，event返回值包含触发事件时的时间戳、鼠标按键、动作、鼠标位置在整个屏幕上的坐标和相对于当前组件的坐标。 |
20
21
22## MouseEvent对象说明
23
24| 名称      | 属性类型                            | 描述                   |
25| --------- | ------------------------------- | -------------------- |
26| screenX   | number                          | 鼠标位置相对于应用窗口左上角的x轴坐标。 |
27| screenY   | number                          | 鼠标位置相对于应用窗口左上角的y轴坐标。 |
28| x         | number                          | 鼠标位置相对于当前组件左上角的x轴坐标。 |
29| y         | number                          | 鼠标位置相对于当前组件左上角的y轴坐标。 |
30| button    | [MouseButton](ts-appendix-enums.md#mousebutton) | 鼠标按键。                |
31| action    | [MouseAction](ts-appendix-enums.md#mouseaction) | 鼠标动作。                |
32| stopPropagation      | () => void | 阻塞事件冒泡。                         |
33| timestamp<sup>8+</sup> | number | 事件时间戳。触发事件时距离系统启动的时间间隔，单位纳秒。 |
34| target<sup>8+</sup> | [EventTarget](ts-universal-events-click.md#eventtarget8对象说明) | 触发事件的元素对象显示区域。 |
35| source<sup>8+</sup> | [SourceType](ts-gesture-settings.md#sourcetype枚举说明) | 事件输入设备。 |
36
37## 示例
38
39```ts
40// xxx.ets
41@Entry
42@Component
43struct MouseEventExample {
44  @State hoverText: string = 'no hover';
45  @State mouseText: string = '';
46  @State action: string = '';
47  @State mouseBtn: string = '';
48  @State color: Color = Color.Blue;
49
50  build() {
51    Column({ space: 20 }) {
52      Button(this.hoverText)
53        .width(180).height(80)
54        .backgroundColor(this.color)
55        .onHover((isHover: boolean) => {
56          // 通过onHover事件动态修改按钮在是否有鼠标悬浮时的文本内容与背景颜色
57          if (isHover) {
58            this.hoverText = 'hover';
59            this.color = Color.Pink;
60          } else {
61            this.hoverText = 'no hover';
62            this.color = Color.Blue;
63          }
64        })
65      Button('onMouse')
66        .width(180).height(80)
67        .onMouse((event: MouseEvent) => {
68          switch (event.button) {
69            case MouseButton.None:
70              this.mouseBtn = 'None';
71              break;
72            case MouseButton.Left:
73              this.mouseBtn = 'Left';
74              break;
75            case MouseButton.Right:
76              this.mouseBtn = 'Right';
77              break;
78            case MouseButton.Back:
79              this.mouseBtn = 'Back';
80              break;
81            case MouseButton.Forward:
82              this.mouseBtn = 'Forward';
83              break;
84            case MouseButton.Middle:
85              this.mouseBtn = 'Middle';
86              break;
87          }
88          switch (event.action) {
89            case MouseAction.Hover:
90              this.action = 'Hover';
91              break;
92            case MouseAction.Press:
93              this.action = 'Press';
94              break;
95            case MouseAction.Move:
96              this.action = 'Move';
97              break;
98            case MouseAction.Release:
99              this.action = 'Release';
100              break;
101          }
102          this.mouseText = 'onMouse:\nButton = ' + this.mouseBtn +
103          '\nAction = ' + this.action + '\nXY=(' + event.x + ',' + event.y + ')' +
104          '\nscreenXY=(' + event.screenX + ',' + event.screenY + ')';
105        })
106      Text(this.mouseText)
107    }.padding({ top: 30 }).width('100%')
108  }
109}
110```
111
112示意图：
113
114鼠标悬浮时改变文本内容与背景颜色：
115
116 ![mouse](figures/mouse.png)
117
118鼠标点击时：
119
120![mouse1](figures/mouse1.png)