@elliemae/ds-floating-context 3.70.0-alpha.12 → 3.70.0-alpha.14

package/dist/cjs/hooks/useFloatingEscape.js

@@ -0,0 +1,74 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var useFloatingEscape_exports = {};
+__export(useFloatingEscape_exports, {
+  useFloatingEscape: () => useFloatingEscape
+});
+module.exports = __toCommonJS(useFloatingEscape_exports);
+var React = __toESM(require("react"));
+var import_react = require("react");
+const useFloatingEscape = ({
+  enabled,
+  floating,
+  reference,
+  onEscapeRef,
+  handleClose,
+  returnFocusToReference
+}) => {
+  const isFocusWithinFloatingScope = (0, import_react.useCallback)(
+    (active) => {
+      if (!active) return false;
+      if (floating && floating.contains(active)) return true;
+      if (!reference) return false;
+      return reference === active || reference.contains(active);
+    },
+    [floating, reference]
+  );
+  (0, import_react.useEffect)(() => {
+    if (!enabled) return void 0;
+    const listener = (event) => {
+      if (event.key !== "Escape") return;
+      if (!isFocusWithinFloatingScope(document.activeElement)) return;
+      const cb = onEscapeRef.current;
+      if (cb) {
+        cb(event);
+      } else {
+        handleClose();
+      }
+      if (returnFocusToReference && reference instanceof HTMLElement) {
+        reference.focus();
+      }
+    };
+    document.addEventListener("keydown", listener, true);
+    return () => {
+      document.removeEventListener("keydown", listener, true);
+    };
+  }, [enabled, handleClose, isFocusWithinFloatingScope, onEscapeRef, reference, returnFocusToReference]);
+};
+//# sourceMappingURL=useFloatingEscape.js.map

package/dist/cjs/hooks/useFloatingEscape.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/hooks/useFloatingEscape.ts", "../../../../../../scripts/build/transpile/react-shim.js"],
+  "sourcesContent": ["import { useCallback, useEffect, type MutableRefObject } from 'react';\n\ninterface UseFloatingEscapeParams {\n  enabled: boolean;\n  floating: HTMLElement | null;\n  reference: Element | null;\n  /** Latest-ref of the consumer's onEscape callback. Construct with `useLatestRef(onEscape)`. */\n  onEscapeRef: MutableRefObject<((event: KeyboardEvent) => void) | undefined>;\n  /** Fallback close handler invoked when no `onEscape` is provided. */\n  handleClose: () => void;\n  /** When true, calls `reference.focus()` after the escape close. */\n  returnFocusToReference: boolean;\n}\n\n/**\n * Listens for `Escape` on the document and dismisses the floating element when focus is\n * within the floating element or on the reference element. Outside that scope the event is\n * ignored \u2014 we don't hijack Escape for unrelated UI on the page.\n */\nexport const useFloatingEscape = ({\n  enabled,\n  floating,\n  reference,\n  onEscapeRef,\n  handleClose,\n  returnFocusToReference,\n}: UseFloatingEscapeParams) => {\n  const isFocusWithinFloatingScope = useCallback(\n    (active: Element | null): boolean => {\n      if (!active) return false;\n      if (floating && floating.contains(active)) return true;\n      if (!reference) return false;\n      return reference === active || reference.contains(active);\n    },\n    [floating, reference],\n  );\n\n  useEffect(() => {\n    if (!enabled) return undefined;\n\n    const listener = (event: KeyboardEvent) => {\n      if (event.key !== 'Escape') return;\n      if (!isFocusWithinFloatingScope(document.activeElement)) return;\n\n      const cb = onEscapeRef.current;\n      if (cb) {\n        cb(event);\n      } else {\n        handleClose();\n      }\n      if (returnFocusToReference && reference instanceof HTMLElement) {\n        reference.focus();\n      }\n    };\n\n    document.addEventListener('keydown', listener, true);\n    return () => {\n      document.removeEventListener('keydown', listener, true);\n    };\n  }, [enabled, handleClose, isFocusWithinFloatingScope, onEscapeRef, reference, returnFocusToReference]);\n};\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,mBAA8D;AAmBvD,MAAM,oBAAoB,CAAC;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA+B;AAC7B,QAAM,iCAA6B;AAAA,IACjC,CAAC,WAAoC;AACnC,UAAI,CAAC,OAAQ,QAAO;AACpB,UAAI,YAAY,SAAS,SAAS,MAAM,EAAG,QAAO;AAClD,UAAI,CAAC,UAAW,QAAO;AACvB,aAAO,cAAc,UAAU,UAAU,SAAS,MAAM;AAAA,IAC1D;AAAA,IACA,CAAC,UAAU,SAAS;AAAA,EACtB;AAEA,8BAAU,MAAM;AACd,QAAI,CAAC,QAAS,QAAO;AAErB,UAAM,WAAW,CAAC,UAAyB;AACzC,UAAI,MAAM,QAAQ,SAAU;AAC5B,UAAI,CAAC,2BAA2B,SAAS,aAAa,EAAG;AAEzD,YAAM,KAAK,YAAY;AACvB,UAAI,IAAI;AACN,WAAG,KAAK;AAAA,MACV,OAAO;AACL,oBAAY;AAAA,MACd;AACA,UAAI,0BAA0B,qBAAqB,aAAa;AAC9D,kBAAU,MAAM;AAAA,MAClB;AAAA,IACF;AAEA,aAAS,iBAAiB,WAAW,UAAU,IAAI;AACnD,WAAO,MAAM;AACX,eAAS,oBAAoB,WAAW,UAAU,IAAI;AAAA,IACxD;AAAA,EACF,GAAG,CAAC,SAAS,aAAa,4BAA4B,aAAa,WAAW,sBAAsB,CAAC;AACvG;",
+  "names": []
+}

package/dist/esm/hooks/useFloatingEscape.js

@@ -0,0 +1,44 @@
+import * as React from "react";
+import { useCallback, useEffect } from "react";
+const useFloatingEscape = ({
+  enabled,
+  floating,
+  reference,
+  onEscapeRef,
+  handleClose,
+  returnFocusToReference
+}) => {
+  const isFocusWithinFloatingScope = useCallback(
+    (active) => {
+      if (!active) return false;
+      if (floating && floating.contains(active)) return true;
+      if (!reference) return false;
+      return reference === active || reference.contains(active);
+    },
+    [floating, reference]
+  );
+  useEffect(() => {
+    if (!enabled) return void 0;
+    const listener = (event) => {
+      if (event.key !== "Escape") return;
+      if (!isFocusWithinFloatingScope(document.activeElement)) return;
+      const cb = onEscapeRef.current;
+      if (cb) {
+        cb(event);
+      } else {
+        handleClose();
+      }
+      if (returnFocusToReference && reference instanceof HTMLElement) {
+        reference.focus();
+      }
+    };
+    document.addEventListener("keydown", listener, true);
+    return () => {
+      document.removeEventListener("keydown", listener, true);
+    };
+  }, [enabled, handleClose, isFocusWithinFloatingScope, onEscapeRef, reference, returnFocusToReference]);
+};
+export {
+  useFloatingEscape
+};
+//# sourceMappingURL=useFloatingEscape.js.map

package/dist/esm/hooks/useFloatingEscape.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../scripts/build/transpile/react-shim.js", "../../../src/hooks/useFloatingEscape.ts"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { useCallback, useEffect, type MutableRefObject } from 'react';\n\ninterface UseFloatingEscapeParams {\n  enabled: boolean;\n  floating: HTMLElement | null;\n  reference: Element | null;\n  /** Latest-ref of the consumer's onEscape callback. Construct with `useLatestRef(onEscape)`. */\n  onEscapeRef: MutableRefObject<((event: KeyboardEvent) => void) | undefined>;\n  /** Fallback close handler invoked when no `onEscape` is provided. */\n  handleClose: () => void;\n  /** When true, calls `reference.focus()` after the escape close. */\n  returnFocusToReference: boolean;\n}\n\n/**\n * Listens for `Escape` on the document and dismisses the floating element when focus is\n * within the floating element or on the reference element. Outside that scope the event is\n * ignored \u2014 we don't hijack Escape for unrelated UI on the page.\n */\nexport const useFloatingEscape = ({\n  enabled,\n  floating,\n  reference,\n  onEscapeRef,\n  handleClose,\n  returnFocusToReference,\n}: UseFloatingEscapeParams) => {\n  const isFocusWithinFloatingScope = useCallback(\n    (active: Element | null): boolean => {\n      if (!active) return false;\n      if (floating && floating.contains(active)) return true;\n      if (!reference) return false;\n      return reference === active || reference.contains(active);\n    },\n    [floating, reference],\n  );\n\n  useEffect(() => {\n    if (!enabled) return undefined;\n\n    const listener = (event: KeyboardEvent) => {\n      if (event.key !== 'Escape') return;\n      if (!isFocusWithinFloatingScope(document.activeElement)) return;\n\n      const cb = onEscapeRef.current;\n      if (cb) {\n        cb(event);\n      } else {\n        handleClose();\n      }\n      if (returnFocusToReference && reference instanceof HTMLElement) {\n        reference.focus();\n      }\n    };\n\n    document.addEventListener('keydown', listener, true);\n    return () => {\n      document.removeEventListener('keydown', listener, true);\n    };\n  }, [enabled, handleClose, isFocusWithinFloatingScope, onEscapeRef, reference, returnFocusToReference]);\n};\n"],
+  "mappings": "AAAA,YAAY,WAAW;ACAvB,SAAS,aAAa,iBAAwC;AAmBvD,MAAM,oBAAoB,CAAC;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA+B;AAC7B,QAAM,6BAA6B;AAAA,IACjC,CAAC,WAAoC;AACnC,UAAI,CAAC,OAAQ,QAAO;AACpB,UAAI,YAAY,SAAS,SAAS,MAAM,EAAG,QAAO;AAClD,UAAI,CAAC,UAAW,QAAO;AACvB,aAAO,cAAc,UAAU,UAAU,SAAS,MAAM;AAAA,IAC1D;AAAA,IACA,CAAC,UAAU,SAAS;AAAA,EACtB;AAEA,YAAU,MAAM;AACd,QAAI,CAAC,QAAS,QAAO;AAErB,UAAM,WAAW,CAAC,UAAyB;AACzC,UAAI,MAAM,QAAQ,SAAU;AAC5B,UAAI,CAAC,2BAA2B,SAAS,aAAa,EAAG;AAEzD,YAAM,KAAK,YAAY;AACvB,UAAI,IAAI;AACN,WAAG,KAAK;AAAA,MACV,OAAO;AACL,oBAAY;AAAA,MACd;AACA,UAAI,0BAA0B,qBAAqB,aAAa;AAC9D,kBAAU,MAAM;AAAA,MAClB;AAAA,IACF;AAEA,aAAS,iBAAiB,WAAW,UAAU,IAAI;AACnD,WAAO,MAAM;AACX,eAAS,oBAAoB,WAAW,UAAU,IAAI;AAAA,IACxD;AAAA,EACF,GAAG,CAAC,SAAS,aAAa,4BAA4B,aAAa,WAAW,sBAAsB,CAAC;AACvG;",
+  "names": []
+}

package/dist/types/hooks/useFloatingEscape.d.ts

@@ -0,0 +1,19 @@
+import { type MutableRefObject } from 'react';
+interface UseFloatingEscapeParams {
+    enabled: boolean;
+    floating: HTMLElement | null;
+    reference: Element | null;
+    /** Latest-ref of the consumer's onEscape callback. Construct with `useLatestRef(onEscape)`. */
+    onEscapeRef: MutableRefObject<((event: KeyboardEvent) => void) | undefined>;
+    /** Fallback close handler invoked when no `onEscape` is provided. */
+    handleClose: () => void;
+    /** When true, calls `reference.focus()` after the escape close. */
+    returnFocusToReference: boolean;
+}
+/**
+ * Listens for `Escape` on the document and dismisses the floating element when focus is
+ * within the floating element or on the reference element. Outside that scope the event is
+ * ignored — we don't hijack Escape for unrelated UI on the page.
+ */
+export declare const useFloatingEscape: ({ enabled, floating, reference, onEscapeRef, handleClose, returnFocusToReference, }: UseFloatingEscapeParams) => void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-floating-context",
-  "version": "3.70.0-alpha.12",
+  "version": "3.70.0-alpha.14",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Popper Hook",
   "files": [
@@ -36,14 +36,14 @@
     "indent": 4
   },
   "dependencies": {
-    "@elliemae/ds-hooks-headless-tooltip": "3.70.0-alpha.12",
-    "@elliemae/ds-system": "3.70.0-alpha.12",
-    "@elliemae/ds-typescript-helpers": "3.70.0-alpha.12",
-    "@elliemae/ds-props-helpers": "3.70.0-alpha.12"
+    "@elliemae/ds-hooks-headless-tooltip": "3.70.0-alpha.14",
+    "@elliemae/ds-props-helpers": "3.70.0-alpha.14",
+    "@elliemae/ds-system": "3.70.0-alpha.14",
+    "@elliemae/ds-typescript-helpers": "3.70.0-alpha.14"
   },
   "devDependencies": {
     "jest": "^30.0.0",
-    "@elliemae/ds-monorepo-devops": "3.70.0-alpha.12"
+    "@elliemae/ds-monorepo-devops": "3.70.0-alpha.14"
   },
   "peerDependencies": {
     "lodash-es": "^4.18.1",