按键事件

2024-01-22 11:18 更新

按键事件指组件与键盘、遥控器等按键设备交互时触发的事件,适用于所有可获焦组件,例如Button。对于Text,Image等默认不可获焦的组件,可以设置focusable属性为true后使用按键事件。

说明

从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

事件

名称

支持冒泡

功能描述

onKeyEvent(event: (event?: KeyEvent) => void)

绑定该方法的组件获焦后,按键动作触发该回调,event返回值见KeyEvent介绍。

KeyEvent对象说明

名称

类型

描述

type

KeyType

按键的类型。

keyCode

number

按键的键码。

keyText

string

按键的键值。

keySource

KeySource

触发当前按键的输入设备类型。

deviceId

number

触发当前按键的输入设备ID。

metaKey

number

按键发生时元键(即Windows键盘的WIN键、Mac键盘的Command键)的状态,1表示按压态,0表示未按压态。

timestamp

number

事件时间戳。触发事件时距离系统启动的时间间隔,单位纳秒。

stopPropagation

() => void

阻塞事件冒泡传递。

示例

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct KeyEventExample {
  5. @State text: string = ''
  6. @State eventType: string = ''
  7. build() {
  8. Column() {
  9. Button('KeyEvent')
  10. .onKeyEvent((event: KeyEvent) => {
  11. if (event.type === KeyType.Down) {
  12. this.eventType = 'Down'
  13. }
  14. if (event.type === KeyType.Up) {
  15. this.eventType = 'Up'
  16. }
  17. this.text = 'KeyType:' + this.eventType + '\nkeyCode:' + event.keyCode + '\nkeyText:' + event.keyText
  18. })
  19. Text(this.text).padding(15)
  20. }.height(300).width('100%').padding(35)
  21. }
  22. }

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号