@versini/ui-hooks 1.0.0 → 2.1.0

package/dist/hooks/useEventListener.js

@@ -0,0 +1,18 @@
+import { useRef as E, useEffect as i } from "react";
+function o(n, c, r, e) {
+  const s = E(c);
+  i(() => {
+    s.current = c;
+  }, [c]), i(() => {
+    const t = (r == null ? void 0 : r.current) ?? window;
+    if (!(t && t.addEventListener))
+      return;
+    const u = (f) => s.current(f);
+    return t.addEventListener(n, u, e), () => {
+      t.removeEventListener(n, u, e);
+    };
+  }, [n, r, e]);
+}
+export {
+  o as useEventListener
+};

package/dist/hooks/useLocalStorage.js

@@ -0,0 +1,61 @@
+import { useCallback as s, useState as f } from "react";
+import { useEventListener as h } from "./useEventListener.js";
+const u = "av-local-storage", E = (t) => {
+  try {
+    return JSON.stringify(t);
+  } catch {
+    throw new Error(
+      "@versini/ui-hooks useLocalStorage: Failed to serialize the value"
+    );
+  }
+}, m = (t) => {
+  try {
+    return t && JSON.parse(t);
+  } catch {
+    return t;
+  }
+};
+function N({
+  key: t,
+  defaultValue: l,
+  deserialize: w = m,
+  serialize: n = (e) => E(e)
+}) {
+  const e = typeof l == "function" ? l() : l, a = s(() => {
+    let o;
+    try {
+      o = typeof window > "u" || !("localStorage" in window) || window.localStorage === null;
+    } catch {
+      o = !0;
+    }
+    if (o)
+      return window.localStorage.setItem(t, n(e)), e;
+    try {
+      const r = window.localStorage.getItem(t);
+      return r !== null ? w(r) : (window.localStorage.setItem(t, n(e)), e);
+    } catch (r) {
+      return console.warn(`Error reading localStorage key “${t}”:`, r), e;
+    }
+  }, [e, w, t, n]), [c, i] = f(a()), g = s(
+    (o) => {
+      try {
+        const r = o instanceof Function ? o(c) : o;
+        if (r === void 0)
+          return;
+        window.localStorage.setItem(t, n(r)), i(r), window.dispatchEvent(new Event(u));
+      } catch (r) {
+        console.warn(`Error setting localStorage key “${t}”:`, r);
+      }
+    },
+    [t, n, c]
+  ), S = s(() => (window.localStorage.removeItem(t), i(a()), window.dispatchEvent(new Event(u)), c), [t, a, c]), d = s(
+    (o) => {
+      o != null && o.key && o.key !== t || i(a());
+    },
+    [t, a]
+  );
+  return h(u, d), [c, g, S];
+}
+export {
+  N as useLocalStorage
+};

package/dist/index.d.ts

@@ -1,3 +1,41 @@
+declare const CUSTOM_EVENT_NAME = "av-local-storage";
+declare global {
+    interface WindowEventMap {
+        [CUSTOM_EVENT_NAME]: CustomEvent;
+    }
+}
+interface StorageProperties<T> {
+    /**
+     * Storage key.
+     */
+    key: string;
+    /**
+     * Default value that will be set if value is not found in storage.
+     */
+    defaultValue?: T;
+    /**
+     * Function to serialize value into string to be saved in storage.
+     */
+    serialize?: (value: T) => string;
+    /**
+     * Function to deserialize string value from storage to value.
+     */
+    deserialize?: (value: string | undefined) => T;
+}
+/**
+ *
+ * @example
+ * import { useLocalStorage } from '@versini/ui-hooks';
+ * const [value, setValue] = useLocalStorage({
+ *   key: 'gpt-model',
+ *   defaultValue: 'gpt-3',
+ * });
+ *
+ * setValue('gpt-4');
+ * setValue((current) => (current === 'gpt-3' ? 'gpt-4' : 'gpt-3'));
+ */
+declare function useLocalStorage<T = string>({ key, defaultValue, deserialize, serialize, }: StorageProperties<T>): [T, (val: T | ((prevState: T) => T)) => void, () => void];
+
 /**
  * React utility to merge refs.
  *
@@ -91,4 +129,4 @@ type UseUniqueIdOptions = string | number | {
 };
 declare function useUniqueId(options?: UseUniqueIdOptions): string | undefined;
 
-export { useMergeRefs, useUncontrolled, useUniqueId };
+export { useLocalStorage, useMergeRefs, useUncontrolled, useUniqueId };

package/dist/index.js

@@ -1,13 +1,16 @@
-import { useMergeRefs as t } from "./hooks/useMergeRefs.js";
-import { useUncontrolled as m } from "./hooks/useUncontrolled.js";
-import { useUniqueId as s } from "./hooks/useUniqueId.js";
+import { useLocalStorage as m } from "./hooks/useLocalStorage.js";
+import { useMergeRefs as f } from "./hooks/useMergeRefs.js";
+import { useUncontrolled as u } from "./hooks/useUncontrolled.js";
+import { useUniqueId as i } from "./hooks/useUniqueId.js";
 import "react";
+import "./hooks/useEventListener.js";
 /*!
-  @versini/ui-hooks v1.0.0
+  @versini/ui-hooks v2.1.0
   © 2024 gizmette.com
 */
 export {
-  t as useMergeRefs,
-  m as useUncontrolled,
-  s as useUniqueId
+  m as useLocalStorage,
+  f as useMergeRefs,
+  u as useUncontrolled,
+  i as useUniqueId
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@versini/ui-hooks",
-	"version": "1.0.0",
+	"version": "2.1.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"publishConfig": {
@@ -41,5 +41,5 @@
 		"react": "18.2.0",
 		"react-dom": "18.2.0"
 	},
-	"gitHead": "b3908b5958fb8dab384172191bab101229be48bd"
+	"gitHead": "f554b1df1fcdd2b47b6e92fd7bbaaf4d91ea53ef"
 }