docs: hotkey

liriliri · Dec 22, 2023 · e911a69 · e911a69
1 parent d67f9cf
commit e911a69
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 8 deletions.
diff --git 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
@@ -6737,8 +6737,15 @@ const hotkey: {
 |参数名|说明|
 |-----|---|
 |key|按键|
+|options|选项|
 |listener|监听器|
 
+选项：
+
+|参数名|说明|
+|-----|---|
+|element=document|目标元素|
+
 ### off
 
 注销监听器。

diff --git 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
@@ -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
  *