@trackunit/react-components 0.1.138 → 0.1.139

package/index.cjs.js

@@ -36672,13 +36672,12 @@ const getWindowSize = () => {
 
 /**
  * @param {UseTimeoutProps} props The props
- * @returns {{ startTimeout: () => void; stopTimeout: () => void; isReady: boolean | null}} return
+ * @returns {{ startTimeout: () => void; stopTimeout: () => void;}} return
  */
 const useTimeout = ({ onTimeout, duration }) => {
     const ready = React.useRef(false);
     const timeout = React.useRef();
     const callback = React.useRef(onTimeout);
-    const isReady = React.useCallback(() => ready.current, []);
     const startTimeout = React.useCallback(() => {
         ready.current = false;
         timeout.current && clearTimeout(timeout.current);
@@ -36691,16 +36690,16 @@ const useTimeout = ({ onTimeout, duration }) => {
         ready.current = null;
         timeout.current && clearTimeout(timeout.current);
     }, []);
-    // update ref when function changes
     React.useEffect(() => {
         callback.current = onTimeout;
     }, [onTimeout]);
-    // startTimeout on mount, stopTimeout on unmount
     React.useEffect(() => {
-        startTimeout();
-        return stopTimeout;
-    }, [duration, startTimeout, stopTimeout]);
-    return [isReady, stopTimeout, startTimeout];
+        // Cleanup function to clear the timeout when component unmounts
+        return () => {
+            timeout.current && clearTimeout(timeout.current);
+        };
+    }, []);
+    return [startTimeout, stopTimeout];
 };
 
 const cvaMoreMenu = cssClassVarianceUtilities.cvaMerge(["p-4"]);

package/index.esm.js

@@ -36645,13 +36645,12 @@ const getWindowSize = () => {
 
 /**
  * @param {UseTimeoutProps} props The props
- * @returns {{ startTimeout: () => void; stopTimeout: () => void; isReady: boolean | null}} return
+ * @returns {{ startTimeout: () => void; stopTimeout: () => void;}} return
  */
 const useTimeout = ({ onTimeout, duration }) => {
     const ready = useRef(false);
     const timeout = useRef();
     const callback = useRef(onTimeout);
-    const isReady = useCallback(() => ready.current, []);
     const startTimeout = useCallback(() => {
         ready.current = false;
         timeout.current && clearTimeout(timeout.current);
@@ -36664,16 +36663,16 @@ const useTimeout = ({ onTimeout, duration }) => {
         ready.current = null;
         timeout.current && clearTimeout(timeout.current);
     }, []);
-    // update ref when function changes
     useEffect(() => {
         callback.current = onTimeout;
     }, [onTimeout]);
-    // startTimeout on mount, stopTimeout on unmount
     useEffect(() => {
-        startTimeout();
-        return stopTimeout;
-    }, [duration, startTimeout, stopTimeout]);
-    return [isReady, stopTimeout, startTimeout];
+        // Cleanup function to clear the timeout when component unmounts
+        return () => {
+            timeout.current && clearTimeout(timeout.current);
+        };
+    }, []);
+    return [startTimeout, stopTimeout];
 };
 
 const cvaMoreMenu = cvaMerge(["p-4"]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-components",
-  "version": "0.1.138",
+  "version": "0.1.139",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/hooks/useTimeout.d.ts

@@ -1,11 +1,12 @@
-export type UseTimeoutReturn = [() => boolean | null, () => void, () => void];
+type Callback = () => void;
+export type UseTimeoutReturn = [Callback, Callback];
 interface UseTimeoutProps {
     onTimeout: () => void;
     duration: number;
 }
 /**
  * @param {UseTimeoutProps} props The props
- * @returns {{ startTimeout: () => void; stopTimeout: () => void; isReady: boolean | null}} return
+ * @returns {{ startTimeout: () => void; stopTimeout: () => void;}} return
  */
 export declare const useTimeout: ({ onTimeout, duration }: UseTimeoutProps) => UseTimeoutReturn;
 export {};