@react-hive/honey-layout 17.6.0 → 17.7.0

package/dist/index.dev.cjs

@@ -5979,32 +5979,35 @@ __webpack_require__.r(__webpack_exports__);
  * It can also subscribe to overlay-level events, such as `keyup`, for the matched overlay.
  *
  * @param targetOverlayId - The ID of the active overlay to find.
- * @param options - Optional overlay event handlers.
+ * @param options - Optional configuration for resolving the overlay and attaching event handlers.
  *
- * @returns The matching active overlay instance, or `undefined` when the overlay is not registered.
+ * @returns The matching active overlay instance, or `null` when the hook is disabled
+ * or the overlay is not currently registered.
  *
  * @remarks
  * - The hook only works with overlays that are currently active.
- * - If the overlay is inactive, unregistered, or already removed from the stack, `undefined` is returned.
- * - The `onKeyUp` listener is attached only to the matched overlay.
- * - Event listeners are automatically cleaned up when the overlay, handler, or component lifecycle changes.
+ * - If `enabled` is `false`, the hook returns `null` and does not attach listeners.
+ * - If the overlay is inactive, unregistered, or already removed from the stack, `null` is returned.
+ * - The `onKeyUp` listener is attached only to the matched overlay while the hook is enabled.
+ * - Event listeners are automatically cleaned up when the overlay, handler, enabled state,
+ * or component lifecycle changes.
  *
  * @example
  * ```tsx
  * const overlay = useHoneyOverlay('my-overlay-id', {
+ *   enabled: isOpen,
  *   onKeyUp: (keyCode, overlay, e) => {
  *     if (keyCode === 'Escape') {
- *      //
+ *       // Handle Escape key.
  *     }
  *   },
  * });
  * ```
  */
-const useHoneyOverlay = (targetOverlayId, { onKeyUp } = {}) => {
+const useHoneyOverlay = (targetOverlayId, { enabled = true, onKeyUp } = {}) => {
     const { overlays } = (0,_hooks__WEBPACK_IMPORTED_MODULE_1__.useHoneyLayout)();
-    const overlay = (0,react__WEBPACK_IMPORTED_MODULE_0__.useMemo)(() => overlays.find(overlay => overlay.id === targetOverlayId), [overlays, targetOverlayId]);
+    const overlay = (0,react__WEBPACK_IMPORTED_MODULE_0__.useMemo)(() => (enabled ? (overlays.find(overlay => overlay.id === targetOverlayId) ?? null) : null), [enabled, overlays, targetOverlayId]);
     (0,react__WEBPACK_IMPORTED_MODULE_0__.useEffect)(() => {
-        // If no overlay is found or no `onKeyUp` handler is provided, skip setting up the listener
         if (!overlay || !onKeyUp) {
             return;
         }