From e911a695eb6e6b35604a2ccb4a317851795ed0e4 Mon Sep 17 00:00:00 2001 From: redhoodsu Date: Fri, 22 Dec 2023 16:25:00 +0800 Subject: [PATCH] docs: hotkey --- DOC.md | 15 +++++++++++---- DOC_CN.md | 7 +++++++ i18n/hotkey.md | 7 +++++++ src/hotkey.js | 15 +++++++++++---- 4 files changed, 36 insertions(+), 8 deletions(-) diff --git a/DOC.md b/DOC.md index 39ade529..07dbd10a 100644 --- a/DOC.md +++ b/DOC.md @@ -6741,10 +6741,17 @@ const hotkey: { Register keyboard listener. -|Name |Desc | -|--------|------------| -|key |Key string | -|listener|Key listener| +|Name |Desc | +|--------|--------------| +|key |Key string | +|options |Hotkey options| +|listener|Key listener | + +Options: + +|Name |Desc | +|----------------|--------------| +|element=document|Target element| ### off diff --git a/DOC_CN.md b/DOC_CN.md index 01fa8965..eda7e3c8 100644 --- a/DOC_CN.md +++ b/DOC_CN.md @@ -6737,8 +6737,15 @@ const hotkey: { |参数名|说明| |-----|---| |key|按键| +|options|选项| |listener|监听器| +选项： + +|参数名|说明| +|-----|---| +|element=document|目标元素| + ### off 注销监听器。 diff --git a/i18n/hotkey.md b/i18n/hotkey.md index 2ff51eb4..90ad6b7c 100644 --- a/i18n/hotkey.md +++ b/i18n/hotkey.md @@ -9,8 +9,15 @@ |参数名|说明| |-----|---| |key|按键| +|options|选项| |listener|监听器| +选项： + +|参数名|说明| +|-----|---| +|element=document|目标元素| + ### off 注销监听器。 diff --git a/src/hotkey.js b/src/hotkey.js index c712f6a6..7aaeebd0 100644 --- a/src/hotkey.js +++ b/src/hotkey.js @@ -4,10 +4,17 @@ * * Register keyboard listener. * - * |Name |Desc | - * |--------|------------| - * |key |Key string | - * |listener|Key listener| + * |Name |Desc | + * |--------|--------------| + * |key |Key string | + * |options |Hotkey options| + * |listener|Key listener | + * + * Options: + * + * |Name |Desc | + * |----------------|--------------| + * |element=document|Target element| * * ### off *