@versini/ui-hooks 4.0.1 → 4.1.1

package/dist/hooks/useIsMounted.js

@@ -0,0 +1,10 @@
+import { useRef as r, useEffect as t, useCallback as u } from "react";
+function s() {
+  const e = r(!1);
+  return t(() => (e.current = !0, () => {
+    e.current = !1;
+  }), []), u(() => e.current, []);
+}
+export {
+  s as useIsMounted
+};

package/dist/hooks/useResizeObserver.js

@@ -0,0 +1,26 @@
+import { useRef as i, useState as m, useMemo as a, useEffect as l } from "react";
+import { useIsMounted as d } from "./useIsMounted.js";
+const R = {
+  x: 0,
+  y: 0,
+  width: 0,
+  height: 0,
+  top: 0,
+  left: 0,
+  bottom: 0,
+  right: 0
+};
+function y(r) {
+  const c = d(), t = i(0), n = i(null), [o, s] = m(R), e = a(() => typeof ResizeObserver > "u" ? null : new ResizeObserver((f) => {
+    const u = f[0];
+    u && (cancelAnimationFrame(t.current), t.current = requestAnimationFrame(() => {
+      n.current && c() && s(u.contentRect);
+    }));
+  }), [c]);
+  return l(() => (n.current && (e == null || e.observe(n.current, r)), () => {
+    e == null || e.disconnect(), t.current && cancelAnimationFrame(t.current);
+  }), [e, r]), [n, o];
+}
+export {
+  y as useResizeObserver
+};

package/dist/index.d.ts

@@ -1,3 +1,19 @@
+import * as react from 'react';
+
+/**
+ * Custom hook that returns a function indicating whether the component
+ * is mounted or not.
+ *
+ * @returns A function that returns a boolean value indicating whether
+ *          the component is mounted.
+ *
+ * @example
+ * const isMounted = useIsMounted();
+ * console.log(isMounted()); // true
+ *
+ */
+declare function useIsMounted(): () => boolean;
+
 interface StorageProperties<T> {
     /**
      * Storage key.
@@ -45,6 +61,23 @@ declare function useLocalStorage<T>({ key, initialValue, }: StorageProperties<T>
  */
 declare function useMergeRefs<T = any>(refs: Array<React.MutableRefObject<T> | React.LegacyRef<T> | undefined | null>): React.RefCallback<T>;
 
+type ObserverRect = Omit<DOMRectReadOnly, "toJSON">;
+/**
+ * A custom hook that uses the ResizeObserver API to track the size changes of a DOM element.
+ *
+ * @template T - The type of the DOM element being observed.
+ * @param {ResizeObserverOptions} [options] - The options to configure the ResizeObserver.
+ * @returns {[React.RefObject<T>, ObserverRect]} - A tuple containing the ref object and
+ *                                                the observed rectangle.
+ * @example
+ *
+ * const [rightElementRef, rect] = useResizeObserver<HTMLDivElement>();
+ * <div ref={componentRef}>
+ *   Observed: <code>{JSON.stringify(rect)}</code>
+ * </div>
+ */
+declare function useResizeObserver<T extends HTMLElement = any>(options?: ResizeObserverOptions): readonly [react.RefObject<T>, ObserverRect];
+
 /**
  * MIT License
  *
@@ -117,4 +150,4 @@ type UseUniqueIdOptions = string | number | {
 };
 declare function useUniqueId(options?: UseUniqueIdOptions): string | undefined;
 
-export { useLocalStorage, useMergeRefs, useUncontrolled, useUniqueId };
+export { useIsMounted, useLocalStorage, useMergeRefs, useResizeObserver, useUncontrolled, useUniqueId };

package/dist/index.js

@@ -1,14 +1,18 @@
-import { useLocalStorage as r } from "./hooks/useLocalStorage.js";
+import { useIsMounted as r } from "./hooks/useIsMounted.js";
+import { useLocalStorage as t } from "./hooks/useLocalStorage.js";
 import { useMergeRefs as f } from "./hooks/useMergeRefs.js";
-import { useUncontrolled as u } from "./hooks/useUncontrolled.js";
-import { useUniqueId as p } from "./hooks/useUniqueId.js";
+import { useResizeObserver as p } from "./hooks/useResizeObserver.js";
+import { useUncontrolled as n } from "./hooks/useUncontrolled.js";
+import { useUniqueId as l } from "./hooks/useUniqueId.js";
 /*!
-  @versini/ui-hooks v4.0.1
+  @versini/ui-hooks v4.1.1
   © 2024 gizmette.com
 */
 export {
-  r as useLocalStorage,
+  r as useIsMounted,
+  t as useLocalStorage,
   f as useMergeRefs,
-  u as useUncontrolled,
-  p as useUniqueId
+  p as useResizeObserver,
+  n as useUncontrolled,
+  l as useUniqueId
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@versini/ui-hooks",
-	"version": "4.0.1",
+	"version": "4.1.1",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"publishConfig": {
@@ -41,5 +41,5 @@
 		"react": "18.3.1",
 		"react-dom": "18.3.1"
 	},
-	"gitHead": "5ddede585a2476c9eddc74162cf10c30d0f1fe88"
+	"gitHead": "0efa39da096a4718e375be4a7118f2e48786f401"
 }