@sanity/ui 3.0.14 → 3.1.0

package/dist/index.d.mts

@@ -2840,9 +2840,16 @@ export declare function useForwardedRef<T>(
 ): React.MutableRefObject<T | null>
 
 /**
+ * Adds global keydown event listener to the window.
+ *
+ * @param onKeyDown - The function to call when a keydown event is triggered.
+ * @param options - The options to pass to the addEventListener function (example, capture: true)
  * @beta
  */
-export declare function useGlobalKeyDown(onKeyDown: (event: KeyboardEvent) => void): void
+export declare function useGlobalKeyDown(
+  onKeyDown: (event: KeyboardEvent) => void,
+  options?: AddEventListenerOptions,
+): void
 
 /**
  * @public

package/dist/index.d.ts

@@ -2840,9 +2840,16 @@ export declare function useForwardedRef<T>(
 ): React.MutableRefObject<T | null>
 
 /**
+ * Adds global keydown event listener to the window.
+ *
+ * @param onKeyDown - The function to call when a keydown event is triggered.
+ * @param options - The options to pass to the addEventListener function (example, capture: true)
  * @beta
  */
-export declare function useGlobalKeyDown(onKeyDown: (event: KeyboardEvent) => void): void
+export declare function useGlobalKeyDown(
+  onKeyDown: (event: KeyboardEvent) => void,
+  options?: AddEventListenerOptions,
+): void
 
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/ui",
-  "version": "3.0.14",
+  "version": "3.1.0",
   "keywords": [
     "sanity",
     "ui",
@@ -195,7 +195,7 @@
     "refractor": "^5.0.0",
     "rimraf": "^5.0.5",
     "semantic-release": "^24.2.7",
-    "start-server-and-test": "^2.0.13",
+    "start-server-and-test": "^2.1.0",
     "storybook": "^8.6.14",
     "styled-components": "npm:@sanity/styled-components@^6.1.22",
     "tsconfig-paths": "^4.2.0",

package/src/core/hooks/useGlobalKeyDown.ts

@@ -2,16 +2,23 @@ import {useEffect} from 'react'
 import {useEffectEvent} from 'use-effect-event'
 
 /**
+ * Adds global keydown event listener to the window.
+ *
+ * @param onKeyDown - The function to call when a keydown event is triggered.
+ * @param options - The options to pass to the addEventListener function (example, capture: true)
  * @beta
  */
-export function useGlobalKeyDown(onKeyDown: (event: KeyboardEvent) => void): void {
+export function useGlobalKeyDown(
+  onKeyDown: (event: KeyboardEvent) => void,
+  options?: AddEventListenerOptions,
+): void {
   const handleKeyDown = useEffectEvent((event: KeyboardEvent) => onKeyDown(event))
 
   useEffect(() => {
     const handler = (event: KeyboardEvent) => handleKeyDown(event)
 
-    window.addEventListener('keydown', handler)
+    window.addEventListener('keydown', handler, options)
 
-    return () => window.removeEventListener('keydown', handler)
-  }, [])
+    return () => window.removeEventListener('keydown', handler, options)
+  }, [options])
 }