鸿蒙5.0开发进阶：API ArkUI框架-ArkTS组件（按键事件）

往期鸿蒙全套实战文章必看：（文中附带全栈鸿蒙学习资料）

• 鸿蒙开发核心知识点，看这篇文章就够了

• 最新版！鸿蒙HarmonyOS Next应用开发实战学习路线

• 鸿蒙HarmonyOS NEXT开发技术最全学习路线指南

• 鸿蒙应用开发实战项目，看这一篇文章就够了（部分项目附源码）

---

按键事件

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

说明

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

onKeyEvent

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

绑定该方法的组件获焦后，按键动作触发该回调。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

参数：

参数名	类型	必填	说明
event	KeyEvent	是	获得KeyEvent对象。

返回值：

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

onKeyPreIme12+

onKeyPreIme(event: Callback<KeyEvent, boolean>): T

绑定该方法的组件获焦后，按键动作优先触发该回调。

该回调的返回值为true时，视作该按键事件已被消费，后续的事件回调（keyboardShortcut、输入法事件、onKeyEvent）会被拦截，不再触发。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名	类型	必填	说明
event	Callback<KeyEvent, boolean>	是	处理按键事件的回调。

返回值：

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

KeyEvent对象说明

元服务API： 从API version 11开始，该接口支持在元服务中使用。

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

名称	类型	描述
type	KeyType	按键的类型。
keyCode	number	按键的键码。
keyText	string	按键的键值。
keySource	KeySource	触发当前按键的输入设备类型。
deviceId	number	触发当前按键的输入设备ID。
metaKey	number	按键发生时元键的状态，1表示按压态，0表示未按压态。
timestamp	number	事件时间戳。触发事件时距离系统启动的时间间隔，单位：ns。
stopPropagation	() => void	阻塞事件冒泡传递。
intentionCode10+	IntentionCode	按键对应的意图。
getModifierKeyState12+	(Array<string>) => bool	获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'|'Alt'|'Shift'|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。 。

错误码：

以下错误码详细介绍。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed.

示例

该示例通过按钮设置了按键事件，按钮获焦时可触发onKeyEvent回调。

// xxx.ets
@Entry
@Component
struct KeyEventExample {
@State text: string = ''
@State eventType: string = ''

build() {
Column() {
Button('KeyEvent')
.onKeyEvent((event?: KeyEvent) => {
if(event){
if (event.type === KeyType.Down) {
this.eventType = 'Down'
}
if (event.type === KeyType.Up) {
this.eventType = 'Up'
}
this.text = 'KeyType:' + this.eventType + '\nkeyCode:' + event.keyCode + '\nkeyText:' + event.keyText + '\nintentionCode:' + event.intentionCode
}
})
Text(this.text).padding(15)
}.height(300).width('100%').padding(35)
}
}