fix(useKeyStroke): fix TS type definition

sheinsight · Oct 29, 2024 · a9b1a5f · a9b1a5f
1 parent c39ec03
commit a9b1a5f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/react-use/src/use-key-stroke/index.mdx b/packages/react-use/src/use-key-stroke/index.mdx
@@ -71,9 +71,9 @@ export type UseKeyStrokeOptions = {
   /**
    * The target to add the event listener to.
    *
-   * @defaultValue window
+   * @defaultValue () => window
    */
-  target?: ElementTarget
+  target?: ElementTarget | (() => Window) | (() => Document)
   /**
    * Set to `true` to use passive event listeners.
    *

diff --git a/packages/react-use/src/use-key-stroke/index.ts b/packages/react-use/src/use-key-stroke/index.ts
@@ -24,7 +24,7 @@ export interface UseKeyStrokeOptions {
    *
    * @defaultValue window
    */
-  target?: ElementTarget
+  target?: ElementTarget | (() => Window) | (() => Document)
   /**
    * Set to `true` to use passive event listeners.
    *

diff --git a/packages/react-use/src/use-key-stroke/index.zh-cn.mdx b/packages/react-use/src/use-key-stroke/index.zh-cn.mdx
@@ -71,9 +71,9 @@ export type UseKeyStrokeOptions = {
   /**
    * 添加事件监听器的目标。
    * 
-   * @defaultValue window
+   * @defaultValue () => window
    */
-  target?: ElementTarget
+  target?: ElementTarget | (() => Window) | (() => Document)
   /**
    * 设置为 `true` 以使用被动事件监听器。
    *