nextemos 2.3.6 → 2.3.7

package/dist/hooks/index.d.ts

@@ -1,2 +1,3 @@
 export { default as useFetch } from './useFetch';
 export { default as useLocalStorage } from './useLocalStorage';
+export { default as useWindowSize } from './useWindowSize';

package/dist/hooks/index.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLocalStorage = exports.useFetch = void 0;
+exports.useWindowSize = exports.useLocalStorage = exports.useFetch = void 0;
 /// hooks
 var useFetch_1 = require("./useFetch");
 Object.defineProperty(exports, "useFetch", { enumerable: true, get: function () { return __importDefault(useFetch_1).default; } });
 var useLocalStorage_1 = require("./useLocalStorage");
 Object.defineProperty(exports, "useLocalStorage", { enumerable: true, get: function () { return __importDefault(useLocalStorage_1).default; } });
+var useWindowSize_1 = require("./useWindowSize");
+Object.defineProperty(exports, "useWindowSize", { enumerable: true, get: function () { return __importDefault(useWindowSize_1).default; } });

package/dist/hooks/useWindowSize.d.ts

@@ -0,0 +1,14 @@
+interface IWindowSize {
+    width: number;
+    height: number;
+}
+/**
+ * useWindowSize Hook
+ *
+ * @description
+ * A custom React hook that listens for the window size and returns it.
+ *
+ * @returns {Object} An object containing the width and height of the window window.
+ */
+declare const useWindowSize: () => IWindowSize;
+export default useWindowSize;

package/dist/hooks/useWindowSize.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = require("react");
+/**
+ * useWindowSize Hook
+ *
+ * @description
+ * A custom React hook that listens for the window size and returns it.
+ *
+ * @returns {Object} An object containing the width and height of the window window.
+ */
+const useWindowSize = () => {
+    const [windowSize, setWindowSize] = (0, react_1.useState)({
+        width: window.innerWidth,
+        height: window.innerHeight,
+    });
+    /**
+     * handleResize
+     *
+     * @description
+     * A function to update the window size state when the window is resized.
+     */
+    const handleResize = () => {
+        setWindowSize({
+            width: window.innerWidth,
+            height: window.innerHeight,
+        });
+    };
+    /**
+     * useEffect Hook
+     *
+     * @description
+     * A React hook that is used for side-effects in functional components.
+     *
+     * @params {Function} () => {} A callback function that contains the side-effect logic.
+     * @params {Array} [] An array of dependencies. When empty, it means the useEffect runs once after the initial render.
+     */
+    (0, react_1.useEffect)(() => {
+        window.addEventListener('resize', handleResize);
+        return () => {
+            window.removeEventListener('resize', handleResize);
+        };
+    }, []);
+    return windowSize;
+};
+exports.default = useWindowSize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nextemos",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "description": "For helpers and hooks used in NextJS projects",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",