@dynamic-labs/sdk-react-core 2.5.3 → 2.6.0

package/src/lib/shared/utils/hooks/index.d.ts

@@ -7,3 +7,4 @@ export { useOnClickOutside } from './useOnClickOutside';
 export { usePreventPageScroll } from './usePreventPageScroll';
 export { useThrottle } from './useThrottle';
 export { usePrefetch } from './usePrefetch';
+export { useEffectOnceCondition } from './useEffectOnceCondition';

package/src/lib/shared/utils/hooks/useEffectOnceCondition/index.d.ts

@@ -0,0 +1 @@
+export { useEffectOnceCondition } from './useEffectOnceCondition';

package/src/lib/shared/utils/hooks/useEffectOnceCondition/useEffectOnceCondition.cjs

@@ -0,0 +1,26 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+
+/**
+ * Hook that runs an effect only once based on a condition.
+ *
+ * @param {Function} effect - The effect callback function to run.
+ * @param {boolean} condition - The condition that determines whether the effect should run.
+ */
+const useEffectOnceCondition = (effect, condition) => {
+    const hasRun = React.useRef(false);
+    const effectRef = React.useRef(effect);
+    effectRef.current = effect;
+    React.useEffect(() => {
+        if (condition && !hasRun.current) {
+            effectRef.current();
+            hasRun.current = true;
+        }
+    }, [condition]);
+};
+
+exports.useEffectOnceCondition = useEffectOnceCondition;

package/src/lib/shared/utils/hooks/useEffectOnceCondition/useEffectOnceCondition.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Hook that runs an effect only once based on a condition.
+ *
+ * @param {Function} effect - The effect callback function to run.
+ * @param {boolean} condition - The condition that determines whether the effect should run.
+ */
+export declare const useEffectOnceCondition: (effect: () => void, condition: boolean) => void;

package/src/lib/shared/utils/hooks/useEffectOnceCondition/useEffectOnceCondition.js

@@ -0,0 +1,22 @@
+'use client'
+import { useRef, useEffect } from 'react';
+
+/**
+ * Hook that runs an effect only once based on a condition.
+ *
+ * @param {Function} effect - The effect callback function to run.
+ * @param {boolean} condition - The condition that determines whether the effect should run.
+ */
+const useEffectOnceCondition = (effect, condition) => {
+    const hasRun = useRef(false);
+    const effectRef = useRef(effect);
+    effectRef.current = effect;
+    useEffect(() => {
+        if (condition && !hasRun.current) {
+            effectRef.current();
+            hasRun.current = true;
+        }
+    }, [condition]);
+};
+
+export { useEffectOnceCondition };