1# 按键事件 2 3按键事件指组件与键盘、遥控器等按键设备交互时触发的事件，适用于所有可获焦组件，例如Button。对于Text，Image等默认不可获焦的组件，可以设置focusable属性为true后使用按键事件。 4 5> **说明：** 6> 7> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## 事件 10 11| 名称 | 支持冒泡 | 功能描述 | 12| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | 13| onKeyEvent(event: (event?: KeyEvent) => void) | 是 | 绑定该方法的组件获焦后，按键动作触发该方法调用，event返回值见[KeyEvent](#keyevent对象说明)介绍。 | 14 15 16## KeyEvent对象说明 17 18| 名称 | 类型 | 描述 | 19| --------------- | ------------------------------------------- | ------------------------------------------------------------ | 20| type | [KeyType](ts-appendix-enums.md#keytype) | 按键的类型。 | 21| keyCode | number | 按键的键码。 | 22| keyText | string | 按键的键值。 | 23| keySource | [KeySource](ts-appendix-enums.md#keysource) | 触发当前按键的输入设备类型。 | 24| deviceId | number | 触发当前按键的输入设备ID。 | 25| metaKey | number | 按键发生时元键（即Windows键盘的WIN键、Mac键盘的Command键）的状态，1表示按压态，0表示未按压态。 | 26| timestamp | number | 按键发生时的时间戳。 | 27| stopPropagation | () => void | 阻塞事件冒泡传递。 | 28 29 30## 示例 31 32```ts 33// xxx.ets 34@Entry 35@Component 36struct KeyEventExample { 37 @State text: string = ''; 38 @State eventType: string = ''; 39 40 build() { 41 Column() { 42 Button('KeyEvent') 43 .onKeyEvent((event: KeyEvent) => { 44 if (event.type === KeyType.Down) { 45 this.eventType = 'Down'; 46 } 47 if (event.type === KeyType.Up) { 48 this.eventType = 'Up'; 49 } 50 this.text = 'KeyType:' + this.eventType + '\nkeyCode:' + event.keyCode + '\nkeyText:' + event.keyText; 51 }) 52 Text(this.text).padding(15) 53 }.height(300).width('100%').padding(35) 54 } 55} 56``` 57 58
