@adamjanicki/ui 1.3.7 → 1.3.9

package/functions/index.d.ts

@@ -1,2 +1,3 @@
 import classNames from "./classNames";
-export { classNames };
+import scrollToId from "./scrollToId";
+export { classNames, scrollToId };

package/functions/index.js

@@ -1,2 +1,3 @@
 import classNames from "./classNames";
-export { classNames };
+import scrollToId from "./scrollToId";
+export { classNames, scrollToId };

package/functions/scrollToId.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Scroll to the element with the given id
+ * @param id the id of the element to scroll to
+ * @param behavior behavior of the scroll
+ */
+export default function scrollToId(id: string, behavior?: ScrollBehavior): void;

package/functions/scrollToId.js

@@ -0,0 +1,17 @@
+/**
+ * Scroll to the element with the given id
+ * @param id the id of the element to scroll to
+ * @param behavior behavior of the scroll
+ */
+export default function scrollToId(id, behavior) {
+    try {
+        // catch cases where hash is not a valid id
+        var element = document.getElementById(id);
+        if (element) {
+            element.scrollIntoView({ behavior: behavior });
+        }
+    }
+    catch (_a) {
+        // do nothing
+    }
+}

package/hooks/useScrollToHash.d.ts

@@ -1,6 +1,20 @@
+type UseScrollToHashConfig = {
+    /**
+     * Whether or not to scroll to the hash
+     * @default true
+     */
+    active?: boolean;
+    /**
+     * The scroll behavior to use
+     */
+    behavior?: ScrollBehavior;
+    /**
+     * Delay in ms to set using setTimeout
+     */
+    delay?: number;
+};
 /**
  * A hook for scrolling to a hash on the page.
- * @returns a function that scrolls to the hash on the page
  */
-declare const useScrollToHash: () => (behavior?: ScrollBehavior) => void;
+declare const useScrollToHash: (config: UseScrollToHashConfig) => void;
 export default useScrollToHash;

package/hooks/useScrollToHash.js

@@ -1,22 +1,21 @@
-import { useCallback } from "react";
+import { useEffect } from "react";
+import scrollToId from "../functions/scrollToId";
 /**
  * A hook for scrolling to a hash on the page.
- * @returns a function that scrolls to the hash on the page
  */
-var useScrollToHash = function () {
-    return useCallback(
-    /**
-     * Scrolls to the hash on the page.
-     * @param behavior the behavior of the scroll
-     */
-    function (behavior) {
+var useScrollToHash = function (config) {
+    var _a = config.active, active = _a === void 0 ? true : _a, behavior = config.behavior, delay = config.delay;
+    useEffect(function () {
         var hash = window.location.hash;
-        if (hash) {
-            var element = document.getElementById(hash.substring(1));
-            if (element) {
-                element.scrollIntoView({ behavior: behavior });
-            }
+        if (!active || (hash === null || hash === void 0 ? void 0 : hash.length) <= 1)
+            return;
+        var id = hash.substring(1);
+        scrollToId(id, behavior);
+        if (delay !== undefined) {
+            var timeout_1 = setTimeout(function () { return scrollToId(id, behavior); }, delay);
+            return function () { return clearTimeout(timeout_1); };
         }
-    }, []);
+        scrollToId(id, behavior);
+    }, [active, behavior, delay]);
 };
 export default useScrollToHash;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamjanicki/ui",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "description": "Basic UI components and hooks for React in TypeScript",
   "main": "./index.js",
   "types": "./index.d.ts",