@adamjanicki/ui 1.4.1 → 1.4.2

package/hooks/index.d.ts

@@ -1,6 +1,6 @@
 export { default as useScrollLock } from "./useScrollLock";
 export { default as useMediaQuery } from "./useMediaQuery";
-export { default as useWatchScroll } from "./useWatchScroll";
+export { default as useScroll } from "./useScroll";
 export { default as useFocusTrap } from "./useFocusTrap";
 export { default as useScrollToHash } from "./useScrollToHash";
 export { default as useWindowResize } from "./useWindowResize";

package/hooks/index.js

@@ -1,6 +1,6 @@
 export { default as useScrollLock } from "./useScrollLock";
 export { default as useMediaQuery } from "./useMediaQuery";
-export { default as useWatchScroll } from "./useWatchScroll";
+export { default as useScroll } from "./useScroll";
 export { default as useFocusTrap } from "./useFocusTrap";
 export { default as useScrollToHash } from "./useScrollToHash";
 export { default as useWindowResize } from "./useWindowResize";

package/hooks/useScroll.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A hook getting the current scroll position of the window.
+ * @returns an object containing the current scroll position of the window.
+ */
+declare const useScroll: () => {
+    scrollX: number;
+    scrollY: number;
+};
+export default useScroll;

package/hooks/useScroll.js

@@ -0,0 +1,23 @@
+import { useEffect, useState } from "react";
+/**
+ * A hook getting the current scroll position of the window.
+ * @returns an object containing the current scroll position of the window.
+ */
+var useScroll = function () {
+    var _a = useState({
+        scrollX: window.scrollX,
+        scrollY: window.scrollY,
+    }), scroll = _a[0], setScroll = _a[1];
+    useEffect(function () {
+        var onScroll = function () {
+            setScroll({
+                scrollX: window.scrollX,
+                scrollY: window.scrollY,
+            });
+        };
+        window.addEventListener("scroll", onScroll);
+        return function () { return window.removeEventListener("scroll", onScroll); };
+    }, []);
+    return scroll;
+};
+export default useScroll;

package/package.json

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

package/hooks/useWatchScroll.d.ts

@@ -1,7 +0,0 @@
-/**
- * A hook for watching the window scroll.
- *
- * @param onScroll the callback for when the window is scrolled
- */
-declare const useWatchScroll: (onScroll: () => void) => void;
-export default useWatchScroll;

package/hooks/useWatchScroll.js

@@ -1,13 +0,0 @@
-import { useEffect } from "react";
-/**
- * A hook for watching the window scroll.
- *
- * @param onScroll the callback for when the window is scrolled
- */
-var useWatchScroll = function (onScroll) {
-    useEffect(function () {
-        window.addEventListener("scroll", onScroll);
-        return function () { return window.removeEventListener("scroll", onScroll); };
-    }, [onScroll]);
-};
-export default useWatchScroll;