1# 按键事件
2
3按键事件指组件与键盘、遥控器等按键设备交互时触发的事件，适用于所有可获焦组件，例如Button。对于Text，Image等默认不可获焦的组件，可以设置focusable属性为true后使用按键事件。
4按键事件触发的流程和具体时机参考[按键事件数据流](../../../ui/arkts-common-events-device-input-event.md#按键事件数据流)。
5
6>  **说明：**
7>
8>  从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
9
10## onKeyEvent
11
12onKeyEvent(event: (event: KeyEvent) => void): T
13
14绑定该方法的组件获焦后，按键动作触发该回调。
15
16**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
17
18**系统能力：** SystemCapability.ArkUI.ArkUI.Full
19
20**参数：**
21
22| 参数名 | 类型                          | 必填 | 说明               |
23| ------ | ----------------------------- | ---- | ------------------ |
24| event  | [KeyEvent](#keyevent对象说明) | 是   | 获得KeyEvent对象。 |
25
26**返回值：**
27
28| 类型 | 说明 |
29| -------- | -------- |
30| T | 返回当前组件。 |
31
32## onKeyPreIme<sup>12+</sup>
33
34onKeyPreIme(event: Callback<KeyEvent, boolean>): T
35
36绑定该方法的组件获焦后，按键动作优先触发该回调。
37
38该回调的返回值为`true`时，视作该按键事件已被消费，后续的事件回调（`keyboardShortcut`、输入法事件、`onKeyEvent`）会被拦截，不再触发。
39
40**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
41
42**系统能力：** SystemCapability.ArkUI.ArkUI.Full
43
44**参数：**
45
46| 参数名 | 类型                          | 必填 | 说明               |
47| ------ | ----------------------------- | ---- | ------------------ |
48| event  | [Callback](./ts-types.md#callback12)<[KeyEvent](#keyevent对象说明), boolean> | 是   | 处理按键事件的回调。 |
49
50**返回值：**
51
52| 类型 | 说明 |
53| -------- | -------- |
54| T | 返回当前组件。 |
55
56## KeyEvent对象说明
57
58**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
59
60**系统能力：** SystemCapability.ArkUI.ArkUI.Full
61
62| 名称                                    | 类型                                       | 描述                         |
63| ------------------------------------- | ---------------------------------------- | -------------------------- |
64| type                                  | [KeyType](ts-appendix-enums.md#keytype)  | 按键的类型。                     |
65| [keyCode](../../apis-input-kit/js-apis-keycode.md#keycode) | number                                   | 按键的键码。                     |
66| keyText                               | string                                   | 按键的键值。                     |
67| keySource                             | [KeySource](ts-appendix-enums.md#keysource) | 触发当前按键的输入设备类型。             |
68| deviceId                              | number                                   | 触发当前按键的输入设备ID。             |
69| metaKey                               | number                                   | 按键发生时元键的状态，1表示按压态，0表示未按压态。 |
70| timestamp                             | number                                   | 事件时间戳。触发事件时距离系统启动的时间间隔，单位：ns。 |
71| stopPropagation                       | () => void                               | 阻塞事件冒泡传递。                  |
72| intentionCode<sup>10+</sup>           | [IntentionCode](../../apis-input-kit/js-apis-intentioncode.md) | 按键对应的意图。       |
73| getModifierKeyState<sup>12+</sup> | (Array&lt;string&gt;) => bool | 获取功能键按压状态。报错信息请参考以下错误码。支持功能键 'Ctrl'\|'Alt'\|'Shift'\|'Fn'，设备外接带Fn键的键盘不支持Fn键查询。 <br/>**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。|
74| unicode<sup>14+</sup>                              | number                                   | 按键的unicode码值。支持范围为非空格的基本拉丁字符：0x0021-0x007E，不支持字符为0。组合键场景下，返回当前keyEvent对应按键的unicode码值。 <br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。|
75
76**错误码**：
77
78以下错误码详细介绍请参考[通用错误码](../../errorcode-universal.md)。
79
80| 错误码ID | 错误信息 |
81| ------- | -------- |
82| 401 | Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. |
83
84## 示例1（触发onKeyEvent回调）
85
86该示例通过按钮设置了按键事件，按钮获焦时可触发onKeyEvent回调。
87
88```ts
89// xxx.ets
90@Entry
91@Component
92struct KeyEventExample {
93  @State text: string = ''
94  @State eventType: string = ''
95
96  build() {
97    Column() {
98      Button('KeyEvent')
99        .onKeyEvent((event?: KeyEvent) => {
100          if(event){
101            if (event.type === KeyType.Down) {
102              this.eventType = 'Down'
103            }
104            if (event.type === KeyType.Up) {
105              this.eventType = 'Up'
106            }
107            this.text = 'KeyType:' + this.eventType + '\nkeyCode:' + event.keyCode + '\nkeyText:' + event.keyText + '\nintentionCode:' + event.intentionCode
108          }
109        })
110      Text(this.text).padding(15)
111    }.height(300).width('100%').padding(35)
112  }
113}
114```
115
116 ![keyEvent](figures/keyEvent.gif)
117
118## 示例2（获取uniCode码值）
119
120该示例通过key事件获取到所按按键的unicode码值。
121
122```ts
123// xxx.ets
124@Entry
125@Component
126struct KeyEventExample {
127  @State text: string = ''
128  @State eventType: string = ''
129  @State keyType: string = ''
130
131  build() {
132    Column({ space: 10 }) {
133      Button('KeyEvent')
134        .onKeyEvent((event?: KeyEvent) => {
135          if(event){
136            if (event.type === KeyType.Down) {
137              this.eventType = 'Down'
138            }
139            if (event.type === KeyType.Up) {
140              this.eventType = 'Up'
141            }
142            if (event.unicode == 97) {
143              this.keyType = 'a'
144            } else if (event.unicode == 65) {
145              this.keyType = 'A'
146            } else {
147              this.keyType = ' '
148            }
149            this.text = 'KeyType:' + this.eventType + '\nUnicode:' + event.unicode + '\nkeyCode:' + event.keyCode + '\nkeyType:' + this.keyType
150          }
151        })
152      Text(this.text).padding(15)
153    }.height(300).width('100%').padding(35)
154  }
155}
156```
157
158![keyEvent](figures/keyEvent_unicode.gif)