@zag-js/interact-outside 0.1.0 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Chakra UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -12,11 +12,8 @@ npm i  @zag-js/interact-outside
 
 ## Contribution
 
-Yes please! See the
-[contributing guidelines](https://github.com/chakra-ui/zag/blob/main/CONTRIBUTING.md)
-for details.
+Yes please! See the [contributing guidelines](https://github.com/chakra-ui/zag/blob/main/CONTRIBUTING.md) for details.
 
 ## Licence
 
-This project is licensed under the terms of the
-[MIT license](https://github.com/chakra-ui/zag/blob/main/LICENSE).
+This project is licensed under the terms of the [MIT license](https://github.com/chakra-ui/zag/blob/main/LICENSE).

package/dist/index.d.ts

@@ -1,6 +1,19 @@
-export declare type InteractOutsideOptions = {
+declare type InteractOutsideHandlers = {
+    onPointerDownOutside?: (event: PointerDownOutsideEvent) => void;
+    onFocusOutside?: (event: FocusOutsideEvent) => void;
+    onInteractOutside?: (event: InteractOutsideEvent) => void;
+};
+declare type InteractOutsideOptions = InteractOutsideHandlers & {
     exclude?: (target: HTMLElement) => boolean;
-    onPointerDownOutside?: (event: Event) => void;
-    onFocusOutside?: (event: Event) => void;
 };
-export declare function trackInteractOutside(node: HTMLElement | null, options: InteractOutsideOptions): () => void;
+declare type EventDetails<T> = {
+    originalEvent: T;
+    contextmenu: boolean;
+    focusable: boolean;
+};
+declare type PointerDownOutsideEvent = CustomEvent<EventDetails<PointerEvent>>;
+declare type FocusOutsideEvent = CustomEvent<EventDetails<FocusEvent>>;
+declare type InteractOutsideEvent = PointerDownOutsideEvent | FocusOutsideEvent;
+declare function trackInteractOutside(node: HTMLElement | null, options: InteractOutsideOptions): (() => void) | undefined;
+
+export { FocusOutsideEvent, InteractOutsideEvent, InteractOutsideHandlers, InteractOutsideOptions, PointerDownOutsideEvent, trackInteractOutside };

package/dist/index.js

@@ -25,35 +25,38 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // ../dom/dist/index.mjs
-var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
 var runIfFn = (v, ...a) => {
   const res = typeof v === "function" ? v(...a) : v;
-  return res != null ? res : void 0;
+  return res ?? void 0;
 };
-var isRef = (v) => hasProp(v, "current");
-function addDomEvent(target, eventName, handler, options) {
-  const node = isRef(target) ? target.current : runIfFn(target);
-  node == null ? void 0 : node.addEventListener(eventName, handler, options);
-  return () => {
-    node == null ? void 0 : node.removeEventListener(eventName, handler, options);
-  };
+var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
+var isDom = () => typeof window !== "undefined";
+function getPlatform() {
+  const agent = navigator.userAgentData;
+  return (agent == null ? void 0 : agent.platform) ?? navigator.platform;
+}
+var pt = (v) => isDom() && v.test(getPlatform());
+var isTouchDevice = () => isDom() && !!navigator.maxTouchPoints;
+var isMac = () => pt(/^Mac/) && !isTouchDevice;
+function isDocument(el) {
+  return el.nodeType === Node.DOCUMENT_NODE;
 }
 function isWindow(value) {
   return (value == null ? void 0 : value.toString()) === "[object Window]";
 }
-function getOwnerDocument(el) {
-  var _a;
+function getDocument(el) {
   if (isWindow(el))
     return el.document;
-  return (_a = el == null ? void 0 : el.ownerDocument) != null ? _a : document;
+  if (isDocument(el))
+    return el;
+  return (el == null ? void 0 : el.ownerDocument) ?? document;
 }
-function getOwnerWindow(el) {
-  var _a;
-  return (_a = el == null ? void 0 : el.ownerDocument.defaultView) != null ? _a : window;
+function getWindow(el) {
+  return (el == null ? void 0 : el.ownerDocument.defaultView) ?? window;
 }
 function getEventTarget(event) {
-  var _a, _b;
-  return (_b = (_a = event.composedPath) == null ? void 0 : _a.call(event)[0]) != null ? _b : event.target;
+  var _a;
+  return ((_a = event.composedPath) == null ? void 0 : _a.call(event)[0]) ?? event.target;
 }
 function contains(parent, child) {
   if (!parent)
@@ -63,21 +66,59 @@ function contains(parent, child) {
 function isHTMLElement(v) {
   return typeof v === "object" && (v == null ? void 0 : v.nodeType) === Node.ELEMENT_NODE && typeof (v == null ? void 0 : v.nodeName) === "string";
 }
+function isVisible(el) {
+  if (!isHTMLElement(el))
+    return false;
+  return el.offsetWidth > 0 || el.offsetHeight > 0 || el.getClientRects().length > 0;
+}
+var isContextMenuEvent = (e) => {
+  return e.button === 2 || isCtrlKey(e) && e.button === 0;
+};
+var isCtrlKey = (v) => isMac() ? v.metaKey && !v.ctrlKey : v.ctrlKey && !v.metaKey;
+function fireCustomEvent(el, type, init) {
+  if (!el)
+    return;
+  const win = getWindow(el);
+  const event = new win.CustomEvent(type, init);
+  return el.dispatchEvent(event);
+}
+var focusableSelector = "input:not([type='hidden']):not([disabled]), select:not([disabled]), textarea:not([disabled]), a[href], button:not([disabled]), [tabindex], iframe, object, embed, area[href], audio[controls], video[controls], [contenteditable]:not([contenteditable='false']), details > summary:first-of-type";
+function isFocusable(element) {
+  if (!element)
+    return false;
+  return element.matches(focusableSelector) && isVisible(element);
+}
+var isRef = (v) => hasProp(v, "current");
+function addDomEvent(target, eventName, handler, options) {
+  const node = isRef(target) ? target.current : runIfFn(target);
+  node == null ? void 0 : node.addEventListener(eventName, handler, options);
+  return () => {
+    node == null ? void 0 : node.removeEventListener(eventName, handler, options);
+  };
+}
+
+// ../core/dist/index.mjs
+var callAll = (...fns) => (...a) => {
+  fns.forEach(function(fn) {
+    fn == null ? void 0 : fn(...a);
+  });
+};
 
 // src/index.ts
+var POINTER_OUTSIDE_EVENT = "pointerdown.outside";
+var FOCUS_OUTSIDE_EVENT = "focus.outside";
 function trackInteractOutside(node, options) {
-  const { exclude, onPointerDownOutside, onFocusOutside } = options;
+  const { exclude, onFocusOutside, onPointerDownOutside, onInteractOutside } = options;
   if (!node)
     return;
-  const doc = getOwnerDocument(node);
-  const win = getOwnerWindow(node);
+  const doc = getDocument(node);
+  const win = getWindow(node);
   function isEventOutside(event) {
     const target = getEventTarget(event);
     if (!(target instanceof win.HTMLElement)) {
       return false;
     }
-    const doc2 = target.ownerDocument;
-    if (!contains(doc2.documentElement, target)) {
+    if (!contains(doc.documentElement, target)) {
       return false;
     }
     if (contains(node, target)) {
@@ -85,23 +126,63 @@ function trackInteractOutside(node, options) {
     }
     return !(exclude == null ? void 0 : exclude(target));
   }
+  let clickHandler;
   function onPointerDown(event) {
-    if (isEventOutside(event)) {
-      onPointerDownOutside == null ? void 0 : onPointerDownOutside(event);
+    function handler() {
+      if (!node || !isEventOutside(event))
+        return;
+      if (onPointerDownOutside || onInteractOutside) {
+        const handler2 = callAll(onPointerDownOutside, onInteractOutside);
+        node.addEventListener(POINTER_OUTSIDE_EVENT, handler2, { once: true });
+      }
+      fireCustomEvent(node, POINTER_OUTSIDE_EVENT, {
+        bubbles: false,
+        cancelable: true,
+        detail: {
+          originalEvent: event,
+          contextmenu: isContextMenuEvent(event),
+          focusable: isFocusable(getEventTarget(event))
+        }
+      });
+    }
+    if (event.pointerType === "touch") {
+      doc.removeEventListener("click", handler);
+      clickHandler = handler;
+      doc.addEventListener("click", handler, { once: true });
+    } else {
+      handler();
     }
   }
   const cleanups = /* @__PURE__ */ new Set();
   const timer = setTimeout(() => {
     cleanups.add(addDomEvent(doc, "pointerdown", onPointerDown, true));
-  });
+  }, 0);
   function onFocusin(event) {
-    if (isEventOutside(event)) {
-      onFocusOutside == null ? void 0 : onFocusOutside(event);
+    if (!node || !isEventOutside(event))
+      return;
+    if (onFocusOutside || onInteractOutside) {
+      const handler = callAll(onFocusOutside, onInteractOutside);
+      node.addEventListener(FOCUS_OUTSIDE_EVENT, handler, { once: true });
     }
+    fireCustomEvent(node, FOCUS_OUTSIDE_EVENT, {
+      bubbles: false,
+      cancelable: true,
+      detail: {
+        originalEvent: event,
+        contextmenu: false,
+        focusable: isFocusable(getEventTarget(event))
+      }
+    });
   }
   cleanups.add(addDomEvent(doc, "focusin", onFocusin, true));
   return () => {
     clearTimeout(timer);
+    if (clickHandler)
+      doc.removeEventListener("click", clickHandler);
     cleanups.forEach((fn) => fn());
   };
 }
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  trackInteractOutside
+});

package/dist/index.mjs

@@ -1,35 +1,36 @@
-"use strict";
-
 // ../dom/dist/index.mjs
-var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
 var runIfFn = (v, ...a) => {
   const res = typeof v === "function" ? v(...a) : v;
-  return res != null ? res : void 0;
+  return res ?? void 0;
 };
-var isRef = (v) => hasProp(v, "current");
-function addDomEvent(target, eventName, handler, options) {
-  const node = isRef(target) ? target.current : runIfFn(target);
-  node == null ? void 0 : node.addEventListener(eventName, handler, options);
-  return () => {
-    node == null ? void 0 : node.removeEventListener(eventName, handler, options);
-  };
+var hasProp = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
+var isDom = () => typeof window !== "undefined";
+function getPlatform() {
+  const agent = navigator.userAgentData;
+  return (agent == null ? void 0 : agent.platform) ?? navigator.platform;
+}
+var pt = (v) => isDom() && v.test(getPlatform());
+var isTouchDevice = () => isDom() && !!navigator.maxTouchPoints;
+var isMac = () => pt(/^Mac/) && !isTouchDevice;
+function isDocument(el) {
+  return el.nodeType === Node.DOCUMENT_NODE;
 }
 function isWindow(value) {
   return (value == null ? void 0 : value.toString()) === "[object Window]";
 }
-function getOwnerDocument(el) {
-  var _a;
+function getDocument(el) {
   if (isWindow(el))
     return el.document;
-  return (_a = el == null ? void 0 : el.ownerDocument) != null ? _a : document;
+  if (isDocument(el))
+    return el;
+  return (el == null ? void 0 : el.ownerDocument) ?? document;
 }
-function getOwnerWindow(el) {
-  var _a;
-  return (_a = el == null ? void 0 : el.ownerDocument.defaultView) != null ? _a : window;
+function getWindow(el) {
+  return (el == null ? void 0 : el.ownerDocument.defaultView) ?? window;
 }
 function getEventTarget(event) {
-  var _a, _b;
-  return (_b = (_a = event.composedPath) == null ? void 0 : _a.call(event)[0]) != null ? _b : event.target;
+  var _a;
+  return ((_a = event.composedPath) == null ? void 0 : _a.call(event)[0]) ?? event.target;
 }
 function contains(parent, child) {
   if (!parent)
@@ -39,21 +40,59 @@ function contains(parent, child) {
 function isHTMLElement(v) {
   return typeof v === "object" && (v == null ? void 0 : v.nodeType) === Node.ELEMENT_NODE && typeof (v == null ? void 0 : v.nodeName) === "string";
 }
+function isVisible(el) {
+  if (!isHTMLElement(el))
+    return false;
+  return el.offsetWidth > 0 || el.offsetHeight > 0 || el.getClientRects().length > 0;
+}
+var isContextMenuEvent = (e) => {
+  return e.button === 2 || isCtrlKey(e) && e.button === 0;
+};
+var isCtrlKey = (v) => isMac() ? v.metaKey && !v.ctrlKey : v.ctrlKey && !v.metaKey;
+function fireCustomEvent(el, type, init) {
+  if (!el)
+    return;
+  const win = getWindow(el);
+  const event = new win.CustomEvent(type, init);
+  return el.dispatchEvent(event);
+}
+var focusableSelector = "input:not([type='hidden']):not([disabled]), select:not([disabled]), textarea:not([disabled]), a[href], button:not([disabled]), [tabindex], iframe, object, embed, area[href], audio[controls], video[controls], [contenteditable]:not([contenteditable='false']), details > summary:first-of-type";
+function isFocusable(element) {
+  if (!element)
+    return false;
+  return element.matches(focusableSelector) && isVisible(element);
+}
+var isRef = (v) => hasProp(v, "current");
+function addDomEvent(target, eventName, handler, options) {
+  const node = isRef(target) ? target.current : runIfFn(target);
+  node == null ? void 0 : node.addEventListener(eventName, handler, options);
+  return () => {
+    node == null ? void 0 : node.removeEventListener(eventName, handler, options);
+  };
+}
+
+// ../core/dist/index.mjs
+var callAll = (...fns) => (...a) => {
+  fns.forEach(function(fn) {
+    fn == null ? void 0 : fn(...a);
+  });
+};
 
 // src/index.ts
+var POINTER_OUTSIDE_EVENT = "pointerdown.outside";
+var FOCUS_OUTSIDE_EVENT = "focus.outside";
 function trackInteractOutside(node, options) {
-  const { exclude, onPointerDownOutside, onFocusOutside } = options;
+  const { exclude, onFocusOutside, onPointerDownOutside, onInteractOutside } = options;
   if (!node)
     return;
-  const doc = getOwnerDocument(node);
-  const win = getOwnerWindow(node);
+  const doc = getDocument(node);
+  const win = getWindow(node);
   function isEventOutside(event) {
     const target = getEventTarget(event);
     if (!(target instanceof win.HTMLElement)) {
       return false;
     }
-    const doc2 = target.ownerDocument;
-    if (!contains(doc2.documentElement, target)) {
+    if (!contains(doc.documentElement, target)) {
       return false;
     }
     if (contains(node, target)) {
@@ -61,23 +100,59 @@ function trackInteractOutside(node, options) {
     }
     return !(exclude == null ? void 0 : exclude(target));
   }
+  let clickHandler;
   function onPointerDown(event) {
-    if (isEventOutside(event)) {
-      onPointerDownOutside == null ? void 0 : onPointerDownOutside(event);
+    function handler() {
+      if (!node || !isEventOutside(event))
+        return;
+      if (onPointerDownOutside || onInteractOutside) {
+        const handler2 = callAll(onPointerDownOutside, onInteractOutside);
+        node.addEventListener(POINTER_OUTSIDE_EVENT, handler2, { once: true });
+      }
+      fireCustomEvent(node, POINTER_OUTSIDE_EVENT, {
+        bubbles: false,
+        cancelable: true,
+        detail: {
+          originalEvent: event,
+          contextmenu: isContextMenuEvent(event),
+          focusable: isFocusable(getEventTarget(event))
+        }
+      });
+    }
+    if (event.pointerType === "touch") {
+      doc.removeEventListener("click", handler);
+      clickHandler = handler;
+      doc.addEventListener("click", handler, { once: true });
+    } else {
+      handler();
     }
   }
   const cleanups = /* @__PURE__ */ new Set();
   const timer = setTimeout(() => {
     cleanups.add(addDomEvent(doc, "pointerdown", onPointerDown, true));
-  });
+  }, 0);
   function onFocusin(event) {
-    if (isEventOutside(event)) {
-      onFocusOutside == null ? void 0 : onFocusOutside(event);
+    if (!node || !isEventOutside(event))
+      return;
+    if (onFocusOutside || onInteractOutside) {
+      const handler = callAll(onFocusOutside, onInteractOutside);
+      node.addEventListener(FOCUS_OUTSIDE_EVENT, handler, { once: true });
     }
+    fireCustomEvent(node, FOCUS_OUTSIDE_EVENT, {
+      bubbles: false,
+      cancelable: true,
+      detail: {
+        originalEvent: event,
+        contextmenu: false,
+        focusable: isFocusable(getEventTarget(event))
+      }
+    });
   }
   cleanups.add(addDomEvent(doc, "focusin", onFocusin, true));
   return () => {
     clearTimeout(timer);
+    if (clickHandler)
+      doc.removeEventListener("click", clickHandler);
     cleanups.forEach((fn) => fn());
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/interact-outside",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Track interations or focus outside an element",
   "keywords": [
     "js",
@@ -18,22 +18,23 @@
   "files": [
     "dist/**/*"
   ],
-  "scripts": {
-    "build:fast": "yarn zag build",
-    "start": "yarn zag build --watch",
-    "build": "yarn zag build --prod",
-    "test": "jest --config ../../../jest.config.js --rootDir tests",
-    "lint": "eslint src --ext .ts,.tsx",
-    "test:ci": "yarn test --ci --runInBand --updateSnapshot",
-    "test:watch": "yarn test --watchAll"
-  },
-  "dependencies": {
-    "@zag-js/dom-utils": "0.1.5"
+  "devDependencies": {
+    "@zag-js/dom-utils": "0.1.8",
+    "@zag-js/utils": "0.1.3"
   },
   "publishConfig": {
     "access": "public"
   },
   "bugs": {
     "url": "https://github.com/chakra-ui/zag/issues"
+  },
+  "scripts": {
+    "build-fast": "tsup src/index.ts --format=esm,cjs",
+    "start": "pnpm build --watch",
+    "build": "tsup src/index.ts --format=esm,cjs --dts",
+    "test": "jest --config ../../../jest.config.js --rootDir tests",
+    "lint": "eslint src --ext .ts,.tsx",
+    "test-ci": "pnpm test --ci --runInBand -u",
+    "test-watch": "pnpm test --watchAll"
   }
-}
+}