Skip to main content
版本：v3

onKey

API_LEVEL 2.0 开始支持，API 兼容性请参考 API_LEVEL。

监听按键事件，只允许注册一个事件，如果多次注册会导致上一次注册的事件失效。

类型​

function onKey(option: Option): void

简化调用方式​

function onKey(callback: (key: Key, event: KeyEvent) => PreventDefault): void

参数​

Option​

属性类型必填默认值说明API_LEVEL
callback(key: Key, event: KeyEvent) => PreventDefault是-按键事件回调函数2.0

Key​

类型说明
number按键名，值参考按键名常量

KeyEvent​

类型说明
number按键事件名，值参考按键事件常量

PreventDefault​

类型说明
boolean是否跳过默认按键行为，true - 跳过，false - 不跳过

常量​

按键名常量​

常量说明API_LEVEL
KEY_BACKBACK 按键2.0
KEY_SELECTSELECT 按键2.0
KEY_HOMEHOME 按键2.0
KEY_UPUP 按键2.0
KEY_DOWNDOWN 按键2.0
KEY_SHORTCUTSHORTCUT 按键2.0

代码示例​

import { onKey, KEY_UP, KEY_EVENT_CLICK } from '@zos/interaction'

onKey({
  callback: (key, keyEvent) => {
    if (key === KEY_UP && keyEvent === KEY_EVENT_CLICK) {
      console.log('up click')
    }
    return true
  },
})