@w3ux/hooks 1.1.0 → 1.1.2-alpha.1

package/cjs/index.d.ts

@@ -1 +1,3 @@
 export * from "./useEffectIgnoreInitial";
+export * from "./useOutsideAlerter";
+export * from "./useSize";

package/cjs/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./useEffectIgnoreInitial"), exports);
+__exportStar(require("./useOutsideAlerter"), exports);
+__exportStar(require("./useSize"), exports);
 
 //# sourceMappingURL=index.js.map
 

package/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAGA,2DAAyC","file":"index.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nexport * from \"./useEffectIgnoreInitial\";\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAGA,2DAAyC;AACzC,sDAAoC;AACpC,4CAA0B","file":"index.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nexport * from \"./useEffectIgnoreInitial\";\nexport * from \"./useOutsideAlerter\";\nexport * from \"./useSize\";\n"]}

package/cjs/useOutsideAlerter.d.ts

@@ -0,0 +1,3 @@
+import { type RefObject } from "react";
+import type { AnyFunction } from "@w3ux/types";
+export declare const useOutsideAlerter: (ref: RefObject<HTMLElement>, callback: AnyFunction, ignore?: string[]) => void;

package/cjs/useOutsideAlerter.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useOutsideAlerter = void 0;
+const react_1 = require("react");
+const useOutsideAlerter = (ref, callback, ignore = []) => {
+    (0, react_1.useEffect)(() => {
+        const handleClickOutside = (ev) => {
+            if (ev) {
+                if (ref.current && !ref.current.contains(ev.target)) {
+                    const target = ev.target;
+                    const tagName = target.tagName.toLowerCase();
+                    const ignored = ignore.some((i) => i.toLowerCase() === tagName || target.closest(`.${i}`) !== null);
+                    if (!ignored) {
+                        callback();
+                    }
+                }
+            }
+        };
+        document.addEventListener("mousedown", handleClickOutside);
+        return () => {
+            document.removeEventListener("mousedown", handleClickOutside);
+        };
+    }, [ref]);
+};
+exports.useOutsideAlerter = useOutsideAlerter;
+
+//# sourceMappingURL=useOutsideAlerter.js.map
+
+//# sourceMappingURL=useOutsideAlerter.js.map

package/cjs/useOutsideAlerter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useOutsideAlerter.tsx"],"names":[],"mappings":";;;AAGA,iCAAkD;AAI3C,MAAM,iBAAiB,GAAG,CAC/B,GAA2B,EAC3B,QAAqB,EACrB,SAAmB,EAAE,EACrB,EAAE;IACF,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,kBAAkB,GAAG,CAAC,EAAW,EAAE,EAAE;YACzC,IAAI,EAAE,EAAE,CAAC;gBACP,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAc,CAAC,EAAE,CAAC;oBAC5D,MAAM,MAAM,GAAG,EAAE,CAAC,MAAqB,CAAC;oBAGxC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;oBAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,WAAW,EAAE,KAAK,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAClE,CAAC;oBAEF,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,QAAQ,EAAE,CAAC;oBACb,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QAC3D,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC;AA7BW,QAAA,iBAAiB,qBA6B5B","file":"useOutsideAlerter.js","sourcesContent":["// Copyright 2024 @polkadot-cloud/polkadot-staking-dashboard authors & contributors\n// SPDX-License-Identifier: GPL-3.0-only\n\nimport { useEffect, type RefObject } from \"react\";\nimport type { AnyFunction, AnyJson } from \"@w3ux/types\";\n\n// A hook that alerts clicks outside of the passed ref.\nexport const useOutsideAlerter = (\n  ref: RefObject<HTMLElement>,\n  callback: AnyFunction,\n  ignore: string[] = []\n) => {\n  useEffect(() => {\n    const handleClickOutside = (ev: AnyJson) => {\n      if (ev) {\n        if (ref.current && !ref.current.contains(ev.target as Node)) {\n          const target = ev.target as HTMLElement;\n          // Ignore tags with a name of `ignore`, or if there is a class of `ignore` in the parent\n          // tree.\n          const tagName = target.tagName.toLowerCase();\n          const ignored = ignore.some(\n            (i) =>\n              i.toLowerCase() === tagName || target.closest(`.${i}`) !== null\n          );\n\n          if (!ignored) {\n            callback();\n          }\n        }\n      }\n    };\n    document.addEventListener(\"mousedown\", handleClickOutside);\n    return () => {\n      document.removeEventListener(\"mousedown\", handleClickOutside);\n    };\n  }, [ref]);\n};\n"]}

package/cjs/useSize.d.ts

@@ -0,0 +1,5 @@
+import type { MutableRefObject } from "react";
+export declare const useSize: (element: MutableRefObject<HTMLElement | null | undefined>, outerElement?: MutableRefObject<HTMLElement | null | undefined>) => {
+    width: number;
+    height: number;
+};

package/cjs/useSize.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSize = void 0;
+const lodash_throttle_1 = __importDefault(require("lodash.throttle"));
+const react_1 = require("react");
+const useSize = (element, outerElement) => {
+    const getSize = (el = null) => {
+        const width = (el === null || el === void 0 ? void 0 : el.offsetWidth) || 0;
+        const height = (el === null || el === void 0 ? void 0 : el.offsetHeight) || 0;
+        return { width, height };
+    };
+    const [size, setSize] = (0, react_1.useState)(getSize(element === null || element === void 0 ? void 0 : element.current));
+    const resizeThrottle = (0, lodash_throttle_1.default)(() => {
+        setSize(getSize(element === null || element === void 0 ? void 0 : element.current));
+    }, 100);
+    (0, react_1.useEffect)(() => {
+        const listenFor = (outerElement === null || outerElement === void 0 ? void 0 : outerElement.current) || window;
+        listenFor.addEventListener("resize", resizeThrottle);
+        return () => {
+            listenFor.removeEventListener("resize", resizeThrottle);
+        };
+    }, [outerElement]);
+    return size;
+};
+exports.useSize = useSize;
+
+//# sourceMappingURL=useSize.js.map
+
+//# sourceMappingURL=useSize.js.map

package/cjs/useSize.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useSize.tsx"],"names":[],"mappings":";;;;;;AAGA,sEAAuC;AAEvC,iCAA4C;AAIrC,MAAM,OAAO,GAAG,CACrB,OAAyD,EACzD,YAA+D,EAC/D,EAAE;IAGF,MAAM,OAAO,GAAG,CAAC,KAAyB,IAAI,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,WAAW,KAAI,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,YAAY,KAAI,CAAC,CAAC;QACrC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC3B,CAAC,CAAC;IAGF,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,IAAA,gBAAQ,EAC9B,OAAO,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,CAC1B,CAAC;IAGF,MAAM,cAAc,GAAG,IAAA,yBAAQ,EAAC,GAAG,EAAE;QACnC,OAAO,CAAC,OAAO,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,CAAC,CAAC;IACrC,CAAC,EAAE,GAAG,CAAC,CAAC;IAGR,IAAA,iBAAS,EAAC,GAAG,EAAE;QAGb,MAAM,SAAS,GAAG,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,KAAI,MAAM,CAAC;QAElD,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAGrD,OAAO,GAAG,EAAE;YACV,SAAS,CAAC,mBAAmB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAGnB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAtCW,QAAA,OAAO,WAsClB","file":"useSize.js","sourcesContent":["// Copyright 2024 @polkadot-cloud/polkadot-staking-dashboard authors & contributors\n// SPDX-License-Identifier: GPL-3.0-only\n\nimport throttle from \"lodash.throttle\";\nimport type { MutableRefObject } from \"react\";\nimport { useEffect, useState } from \"react\";\n\n// Custom hook to get the width and height of a specified element. Updates the `size` state when the\n// specified \"outer element\" (or the window by default) resizes.\nexport const useSize = (\n  element: MutableRefObject<HTMLElement | null | undefined>,\n  outerElement?: MutableRefObject<HTMLElement | null | undefined>\n) => {\n  // Helper function to retrieve the width and height of an element\n  // If no element is found, default dimensions are set to 0.\n  const getSize = (el: HTMLElement | null = null) => {\n    const width = el?.offsetWidth || 0;\n    const height = el?.offsetHeight || 0;\n    return { width, height };\n  };\n\n  // State to store the current width and height of the specified element.\n  const [size, setSize] = useState<{ width: number; height: number }>(\n    getSize(element?.current)\n  );\n\n  // Throttle the resize event handler to limit how often size updates occur.\n  const resizeThrottle = throttle(() => {\n    setSize(getSize(element?.current));\n  }, 100);\n\n  // Set up the resize event listener on mount and clean it up on unmount.\n  useEffect(() => {\n    // Determine the target for the resize event listener.\n    // If `outerElement` is provided, listen to its resize events; otherwise, listen to the window's.\n    const listenFor = outerElement?.current || window;\n\n    listenFor.addEventListener(\"resize\", resizeThrottle);\n\n    // Clean up event listener when the component unmounts to avoid memory leaks.\n    return () => {\n      listenFor.removeEventListener(\"resize\", resizeThrottle);\n    };\n  }, [outerElement]);\n\n  // Return the current size of the element.\n  return size;\n};\n"]}

package/mjs/index.d.ts

@@ -1 +1,3 @@
 export * from "./useEffectIgnoreInitial";
+export * from "./useOutsideAlerter";
+export * from "./useSize";

package/mjs/index.js

@@ -1,4 +1,6 @@
 export * from "./useEffectIgnoreInitial";
+export * from "./useOutsideAlerter";
+export * from "./useSize";
 
 //# sourceMappingURL=index.js.map
 

package/mjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,0BAA0B,CAAC","file":"index.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nexport * from \"./useEffectIgnoreInitial\";\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,WAAW,CAAC","file":"index.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nexport * from \"./useEffectIgnoreInitial\";\nexport * from \"./useOutsideAlerter\";\nexport * from \"./useSize\";\n"]}

package/mjs/useOutsideAlerter.d.ts

@@ -0,0 +1,3 @@
+import { type RefObject } from "react";
+import type { AnyFunction } from "@w3ux/types";
+export declare const useOutsideAlerter: (ref: RefObject<HTMLElement>, callback: AnyFunction, ignore?: string[]) => void;

package/mjs/useOutsideAlerter.js

@@ -0,0 +1,25 @@
+import { useEffect } from "react";
+export const useOutsideAlerter = (ref, callback, ignore = []) => {
+    useEffect(() => {
+        const handleClickOutside = (ev) => {
+            if (ev) {
+                if (ref.current && !ref.current.contains(ev.target)) {
+                    const target = ev.target;
+                    const tagName = target.tagName.toLowerCase();
+                    const ignored = ignore.some((i) => i.toLowerCase() === tagName || target.closest(`.${i}`) !== null);
+                    if (!ignored) {
+                        callback();
+                    }
+                }
+            }
+        };
+        document.addEventListener("mousedown", handleClickOutside);
+        return () => {
+            document.removeEventListener("mousedown", handleClickOutside);
+        };
+    }, [ref]);
+};
+
+//# sourceMappingURL=useOutsideAlerter.js.map
+
+//# sourceMappingURL=useOutsideAlerter.js.map

package/mjs/useOutsideAlerter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useOutsideAlerter.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAkB,MAAM,OAAO,CAAC;AAIlD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAA2B,EAC3B,QAAqB,EACrB,SAAmB,EAAE,EACrB,EAAE;IACF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,kBAAkB,GAAG,CAAC,EAAW,EAAE,EAAE;YACzC,IAAI,EAAE,EAAE,CAAC;gBACP,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAc,CAAC,EAAE,CAAC;oBAC5D,MAAM,MAAM,GAAG,EAAE,CAAC,MAAqB,CAAC;oBAGxC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;oBAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,WAAW,EAAE,KAAK,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAClE,CAAC;oBAEF,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,QAAQ,EAAE,CAAC;oBACb,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QAC3D,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC","file":"useOutsideAlerter.js","sourcesContent":["// Copyright 2024 @polkadot-cloud/polkadot-staking-dashboard authors & contributors\n// SPDX-License-Identifier: GPL-3.0-only\n\nimport { useEffect, type RefObject } from \"react\";\nimport type { AnyFunction, AnyJson } from \"@w3ux/types\";\n\n// A hook that alerts clicks outside of the passed ref.\nexport const useOutsideAlerter = (\n  ref: RefObject<HTMLElement>,\n  callback: AnyFunction,\n  ignore: string[] = []\n) => {\n  useEffect(() => {\n    const handleClickOutside = (ev: AnyJson) => {\n      if (ev) {\n        if (ref.current && !ref.current.contains(ev.target as Node)) {\n          const target = ev.target as HTMLElement;\n          // Ignore tags with a name of `ignore`, or if there is a class of `ignore` in the parent\n          // tree.\n          const tagName = target.tagName.toLowerCase();\n          const ignored = ignore.some(\n            (i) =>\n              i.toLowerCase() === tagName || target.closest(`.${i}`) !== null\n          );\n\n          if (!ignored) {\n            callback();\n          }\n        }\n      }\n    };\n    document.addEventListener(\"mousedown\", handleClickOutside);\n    return () => {\n      document.removeEventListener(\"mousedown\", handleClickOutside);\n    };\n  }, [ref]);\n};\n"]}

package/mjs/useSize.d.ts

@@ -0,0 +1,5 @@
+import type { MutableRefObject } from "react";
+export declare const useSize: (element: MutableRefObject<HTMLElement | null | undefined>, outerElement?: MutableRefObject<HTMLElement | null | undefined>) => {
+    width: number;
+    height: number;
+};

package/mjs/useSize.js

@@ -0,0 +1,25 @@
+import throttle from "lodash.throttle";
+import { useEffect, useState } from "react";
+export const useSize = (element, outerElement) => {
+    const getSize = (el = null) => {
+        const width = el?.offsetWidth || 0;
+        const height = el?.offsetHeight || 0;
+        return { width, height };
+    };
+    const [size, setSize] = useState(getSize(element?.current));
+    const resizeThrottle = throttle(() => {
+        setSize(getSize(element?.current));
+    }, 100);
+    useEffect(() => {
+        const listenFor = outerElement?.current || window;
+        listenFor.addEventListener("resize", resizeThrottle);
+        return () => {
+            listenFor.removeEventListener("resize", resizeThrottle);
+        };
+    }, [outerElement]);
+    return size;
+};
+
+//# sourceMappingURL=useSize.js.map
+
+//# sourceMappingURL=useSize.js.map

package/mjs/useSize.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useSize.tsx"],"names":[],"mappings":"AAGA,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAI5C,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,OAAyD,EACzD,YAA+D,EAC/D,EAAE;IAGF,MAAM,OAAO,GAAG,CAAC,KAAyB,IAAI,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,EAAE,EAAE,WAAW,IAAI,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,EAAE,EAAE,YAAY,IAAI,CAAC,CAAC;QACrC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC3B,CAAC,CAAC;IAGF,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAC9B,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAC1B,CAAC;IAGF,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,EAAE;QACnC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACrC,CAAC,EAAE,GAAG,CAAC,CAAC;IAGR,SAAS,CAAC,GAAG,EAAE;QAGb,MAAM,SAAS,GAAG,YAAY,EAAE,OAAO,IAAI,MAAM,CAAC;QAElD,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAGrD,OAAO,GAAG,EAAE;YACV,SAAS,CAAC,mBAAmB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1D,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAGnB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC","file":"useSize.js","sourcesContent":["// Copyright 2024 @polkadot-cloud/polkadot-staking-dashboard authors & contributors\n// SPDX-License-Identifier: GPL-3.0-only\n\nimport throttle from \"lodash.throttle\";\nimport type { MutableRefObject } from \"react\";\nimport { useEffect, useState } from \"react\";\n\n// Custom hook to get the width and height of a specified element. Updates the `size` state when the\n// specified \"outer element\" (or the window by default) resizes.\nexport const useSize = (\n  element: MutableRefObject<HTMLElement | null | undefined>,\n  outerElement?: MutableRefObject<HTMLElement | null | undefined>\n) => {\n  // Helper function to retrieve the width and height of an element\n  // If no element is found, default dimensions are set to 0.\n  const getSize = (el: HTMLElement | null = null) => {\n    const width = el?.offsetWidth || 0;\n    const height = el?.offsetHeight || 0;\n    return { width, height };\n  };\n\n  // State to store the current width and height of the specified element.\n  const [size, setSize] = useState<{ width: number; height: number }>(\n    getSize(element?.current)\n  );\n\n  // Throttle the resize event handler to limit how often size updates occur.\n  const resizeThrottle = throttle(() => {\n    setSize(getSize(element?.current));\n  }, 100);\n\n  // Set up the resize event listener on mount and clean it up on unmount.\n  useEffect(() => {\n    // Determine the target for the resize event listener.\n    // If `outerElement` is provided, listen to its resize events; otherwise, listen to the window's.\n    const listenFor = outerElement?.current || window;\n\n    listenFor.addEventListener(\"resize\", resizeThrottle);\n\n    // Clean up event listener when the component unmounts to avoid memory leaks.\n    return () => {\n      listenFor.removeEventListener(\"resize\", resizeThrottle);\n    };\n  }, [outerElement]);\n\n  // Return the current size of the element.\n  return size;\n};\n"]}

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@w3ux/hooks",
-  "version": "1.1.0",
+  "version": "1.1.2-alpha.1",
   "license": "GPL-3.0-only",
+  "dependencies": {
+    "lodash.throttle": "^4.1.1"
+  },
   "main": "cjs/index.js",
   "module": "mjs/index.js",
   "exports": {