开发者可以设置组件的自定义组合键,组件在未获得焦点状态下也可以响应自定义组合键,每个组件可以设置多个组合键。
开发者在设置组合键的同时可以设置自定义事件,组合键按下时,触发该自定义事件,若没有设置自定义事件,则组合键行为与click行为一致。
说明:
从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
keyboardShortcut
keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T
设置组件的自定义组合键。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
value | string | FunctionKey | 是 | 热键的单个字符(可以通过键盘输入的字符)或FunctionKey。 空字符串意为取消快捷键绑定。 |
keys | Array<ModifierKey> | 是 | 热键组合。 仅当value为FunctionKey的情况下可以为空。 |
action | () => void | 否 | 组合快捷键触发成功后的自定义事件回调。 |
返回值:
类型 | 说明 |
---|---|
T | 返回当前组件。 |
ModifierKey
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 描述 |
---|---|
CTRL | 表示键盘上Ctrl键。 |
SHIFT | 表示键盘上Shift键。 |
ALT | 表示键盘上Alt键。 |
FunctionKey
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 描述 |
---|---|
ESC | 表示键盘上ESC功能键。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
F1 | 表示键盘上F1功能键。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
F2 | 表示键盘上F2功能键。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
F3 | 表示键盘上F3功能键。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
F4 | 表示键盘上F4功能键。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |