Teal TealUI

键盘按下事件web/keyPress

绑定常用键盘按键。

import keyPress from "web/keyPress";

keyPress(elem, {
    up() {
        console.log("上");
    },
    enter() {
        console.log("回车");
    }
});
API
全局
KeyPressOptions 接口

API

全局

函数 描述
⮞ keyPress(elem, options)(elem:HTMLElement, options:KeyPressOptions):void

绑定指定元素的键盘按键事件。

参数 类型 描述 默认值
elem* HTMLElement —
options* KeyPressOptions —

返回值

类型：void

绑定指定元素的键盘按键事件。

KeyPressOptions 接口

表示键盘按键选项。

字段 类型 描述
⮞ [key] : (e: KeyboardEvent) => boolean | void

按下指定的按键执行。

参数 类型 描述 默认值
key* string —

返回值

类型：(e: KeyboardEvent) => boolean | void

如果函数返回 false 则表示执行默认的操作。

 function

按下指定的按键执行。
⮞ esc : (e: KeyboardEvent) => boolean | void

按下 ESC 执行。

 function

按下 ESC 执行。
⮞ up : (e: KeyboardEvent) => boolean | void

按下方向上后执行。

 function

按下方向上后执行。
⮞ down : (e: KeyboardEvent) => boolean | void

按下方向下后执行。

 function

按下方向下后执行。
⮞ left : (e: KeyboardEvent) => boolean | void

按下方向左后执行。

 function

按下方向左后执行。
⮞ right : (e: KeyboardEvent) => boolean | void

按下方向右后执行。

 function

按下方向右后执行。
⮞ pageUp : (e: KeyboardEvent) => boolean | void

按下向上翻页执行。

 function

按下向上翻页执行。
⮞ pageDown : (e: KeyboardEvent) => boolean | void

按下向下翻页执行。

 function

按下向下翻页执行。
⮞ home : (e: KeyboardEvent) => boolean | void

按下主页执行。

 function

按下主页执行。
⮞ end : (e: KeyboardEvent) => boolean | void

按下尾页执行。

 function

按下尾页执行。
⮞ enter : (e: KeyboardEvent) => boolean | void

按下回车后执行。

 function

按下回车后执行。
⮞ ctrlEnter : (e: KeyboardEvent) => boolean | void

按下Ctrl/Command+回车后执行。

 function

按下Ctrl/Command+回车后执行。
⮞ space : (e: KeyboardEvent) => boolean | void

按下空格后执行。

 function

按下空格后执行。
⮞ tab : (e: KeyboardEvent) => boolean | void

按下制表符执行。

 function

按下制表符执行。
⮞ backspace : (e: KeyboardEvent) => boolean | void

按下退格后执行。

 function

按下退格后执行。
⮞ delete : (e: KeyboardEvent) => boolean | void

按下删除后执行。

 function

按下删除后执行。
⮞ other : (e: KeyboardEvent) => void

按下其它键执行。

 function

按下其它键执行。