@reactuses/core 2.2.0 → 2.2.2

package/dist/index.cjs

@@ -81,6 +81,49 @@ function useEvent(fn) {
   }, []);
 }
 
+const isPrimitive$1 = (val) => val !== Object(val);
+function useCustomCompareEffect(effect, deps, depsEqual) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!(deps instanceof Array) || !deps.length) {
+      console.warn(
+        "`useCustomCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
+      );
+    }
+    if (deps.every(isPrimitive$1)) {
+      console.warn(
+        "`useCustomCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
+      );
+    }
+    if (typeof depsEqual !== "function") {
+      console.warn(
+        "`useCustomCompareEffect` should be used with depsEqual callback for comparing deps list"
+      );
+    }
+  }
+  const ref = React.useRef(void 0);
+  if (!ref.current || !depsEqual(deps, ref.current)) {
+    ref.current = deps;
+  }
+  React.useEffect(effect, ref.current);
+}
+
+const isPrimitive = (val) => val !== Object(val);
+function useDeepCompareEffect(effect, deps) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!(deps instanceof Array) || !deps.length) {
+      console.warn(
+        "`useDeepCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
+      );
+    }
+    if (deps.every(isPrimitive)) {
+      console.warn(
+        "`useDeepCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
+      );
+    }
+  }
+  useCustomCompareEffect(effect, deps, lodash.isEqual);
+}
+
 const StorageSerializers = {
   boolean: {
     read: (v) => v === "true",
@@ -116,38 +159,38 @@ const StorageSerializers = {
   }
 };
 function useStorage(key, defaults, getStorage, options = {}) {
-  var _a;
+  const defaultOnError = React.useCallback((e) => {
+    console.error(e);
+  }, []);
   let storage;
-  const {
-    onError = (e) => {
-      console.error(e);
-    }
-  } = options;
-  const data = defaults;
+  const { onError = defaultOnError, ignoreDefaults = true } = options;
   try {
     storage = getStorage();
   } catch (err) {
-    console.error(err);
+    onError(err);
   }
   const type = guessSerializerType(defaults);
-  const serializer = (_a = options.serializer) != null ? _a : StorageSerializers[type];
-  const getStoredValue = useEvent(() => {
-    try {
-      const raw = storage == null ? void 0 : storage.getItem(key);
-      if (raw !== void 0 && raw !== null) {
-        return serializer.read(raw);
-      } else {
-        storage == null ? void 0 : storage.setItem(key, serializer.write(data));
-        return data;
-      }
-    } catch (e) {
-      onError(e);
-    }
-  });
+  const serializer = React.useMemo(() => {
+    var _a;
+    return (_a = options.serializer) != null ? _a : StorageSerializers[type];
+  }, [options.serializer, type]);
   const [state, setState] = React.useState(defaults);
-  React.useEffect(() => {
+  useDeepCompareEffect(() => {
+    const getStoredValue = () => {
+      try {
+        const raw = storage == null ? void 0 : storage.getItem(key);
+        if (raw !== void 0 && raw !== null && ignoreDefaults) {
+          return serializer.read(raw);
+        } else {
+          storage == null ? void 0 : storage.setItem(key, serializer.write(defaults));
+          return defaults;
+        }
+      } catch (e) {
+        onError(e);
+      }
+    };
     setState(getStoredValue());
-  }, [getStoredValue, key]);
+  }, [key, ignoreDefaults, defaults, serializer, storage, onError]);
   const updateState = useEvent(
     (valOrFunc) => {
       const currentState = isFunction(valOrFunc) ? valOrFunc(state) : valOrFunc;
@@ -261,7 +304,9 @@ function useDarkMode(options = {}) {
   } = options;
   const prefersDarkMode = usePreferredDark(false);
   const value = initialValue ? initialValue : prefersDarkMode ? "dark" : "light";
-  const [dark, setDark] = useStorage(storageKey, value, storage);
+  const [dark, setDark] = useStorage(storageKey, value, storage, {
+    ignoreDefaults: false
+  });
   const wrappedSetDark = React.useCallback(
     (latestDark) => {
       const element = window == null ? void 0 : window.document.querySelector(selector);
@@ -509,49 +554,6 @@ function useLatestElement(target, defaultElement) {
   return ref;
 }
 
-const isPrimitive$1 = (val) => val !== Object(val);
-function useCustomCompareEffect(effect, deps, depsEqual) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!(deps instanceof Array) || !deps.length) {
-      console.warn(
-        "`useCustomCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
-      );
-    }
-    if (deps.every(isPrimitive$1)) {
-      console.warn(
-        "`useCustomCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
-      );
-    }
-    if (typeof depsEqual !== "function") {
-      console.warn(
-        "`useCustomCompareEffect` should be used with depsEqual callback for comparing deps list"
-      );
-    }
-  }
-  const ref = React.useRef(void 0);
-  if (!ref.current || !depsEqual(deps, ref.current)) {
-    ref.current = deps;
-  }
-  React.useEffect(effect, ref.current);
-}
-
-const isPrimitive = (val) => val !== Object(val);
-function useDeepCompareEffect(effect, deps) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!(deps instanceof Array) || !deps.length) {
-      console.warn(
-        "`useDeepCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
-      );
-    }
-    if (deps.every(isPrimitive)) {
-      console.warn(
-        "`useDeepCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
-      );
-    }
-  }
-  useCustomCompareEffect(effect, deps, lodash.isEqual);
-}
-
 function useEventListener(eventName, handler, element, options) {
   const savedHandler = useLatest(handler);
   const targetElementRef = useLatestElement(element, defaultWindow);

package/dist/index.d.ts

@@ -27,6 +27,10 @@ interface UseStorageOptions<T> {
      * Default log error to `console.error`
      */
     onError?: (error: unknown) => void;
+    /**
+     * ignore default value when storage has value
+     */
+    ignoreDefaults?: boolean;
 }
 
 declare function useLocalStorage(key: string, defaults: string, options?: UseStorageOptions<string>): readonly [string | null, Dispatch<SetStateAction<string | null>>];
@@ -74,8 +78,7 @@ interface UseDarkOptions<T> {
      */
     attribute?: string;
     /**
-     * The initial value write the target element, defaultValue follow system prefer color
-     * must be set in SSR
+     * The initial classname value write the target element, Otherwise, it will follow the system by default
      * @default 'light | dark'
      */
     initialValue?: T;
@@ -92,7 +95,7 @@ interface UseDarkOptions<T> {
      */
     storage?: () => Storage;
 }
-declare function useDarkMode<T extends string | "light" | "dark">(options?: UseDarkOptions<T>): readonly [T | null, (latestDark: T) => void];
+declare function useDarkMode<T extends string>(options?: UseDarkOptions<T>): readonly [T | null, (latestDark: T) => void];
 
 declare function useMediaQuery(query: string, defaultState?: boolean): boolean;
 

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import React, { useRef, useEffect, useLayoutEffect, useCallback, useState, useReducer, useMemo } from 'react';
-import { throttle, debounce, isEqual } from 'lodash';
+import React, { useRef, useEffect, useLayoutEffect, useCallback, useMemo, useState, useReducer } from 'react';
+import { isEqual, throttle, debounce } from 'lodash';
 
 function usePrevious(state) {
   const ref = useRef();
@@ -73,6 +73,49 @@ function useEvent(fn) {
   }, []);
 }
 
+const isPrimitive$1 = (val) => val !== Object(val);
+function useCustomCompareEffect(effect, deps, depsEqual) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!(deps instanceof Array) || !deps.length) {
+      console.warn(
+        "`useCustomCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
+      );
+    }
+    if (deps.every(isPrimitive$1)) {
+      console.warn(
+        "`useCustomCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
+      );
+    }
+    if (typeof depsEqual !== "function") {
+      console.warn(
+        "`useCustomCompareEffect` should be used with depsEqual callback for comparing deps list"
+      );
+    }
+  }
+  const ref = useRef(void 0);
+  if (!ref.current || !depsEqual(deps, ref.current)) {
+    ref.current = deps;
+  }
+  useEffect(effect, ref.current);
+}
+
+const isPrimitive = (val) => val !== Object(val);
+function useDeepCompareEffect(effect, deps) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!(deps instanceof Array) || !deps.length) {
+      console.warn(
+        "`useDeepCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
+      );
+    }
+    if (deps.every(isPrimitive)) {
+      console.warn(
+        "`useDeepCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
+      );
+    }
+  }
+  useCustomCompareEffect(effect, deps, isEqual);
+}
+
 const StorageSerializers = {
   boolean: {
     read: (v) => v === "true",
@@ -108,38 +151,38 @@ const StorageSerializers = {
   }
 };
 function useStorage(key, defaults, getStorage, options = {}) {
-  var _a;
+  const defaultOnError = useCallback((e) => {
+    console.error(e);
+  }, []);
   let storage;
-  const {
-    onError = (e) => {
-      console.error(e);
-    }
-  } = options;
-  const data = defaults;
+  const { onError = defaultOnError, ignoreDefaults = true } = options;
   try {
     storage = getStorage();
   } catch (err) {
-    console.error(err);
+    onError(err);
   }
   const type = guessSerializerType(defaults);
-  const serializer = (_a = options.serializer) != null ? _a : StorageSerializers[type];
-  const getStoredValue = useEvent(() => {
-    try {
-      const raw = storage == null ? void 0 : storage.getItem(key);
-      if (raw !== void 0 && raw !== null) {
-        return serializer.read(raw);
-      } else {
-        storage == null ? void 0 : storage.setItem(key, serializer.write(data));
-        return data;
-      }
-    } catch (e) {
-      onError(e);
-    }
-  });
+  const serializer = useMemo(() => {
+    var _a;
+    return (_a = options.serializer) != null ? _a : StorageSerializers[type];
+  }, [options.serializer, type]);
   const [state, setState] = useState(defaults);
-  useEffect(() => {
+  useDeepCompareEffect(() => {
+    const getStoredValue = () => {
+      try {
+        const raw = storage == null ? void 0 : storage.getItem(key);
+        if (raw !== void 0 && raw !== null && ignoreDefaults) {
+          return serializer.read(raw);
+        } else {
+          storage == null ? void 0 : storage.setItem(key, serializer.write(defaults));
+          return defaults;
+        }
+      } catch (e) {
+        onError(e);
+      }
+    };
     setState(getStoredValue());
-  }, [getStoredValue, key]);
+  }, [key, ignoreDefaults, defaults, serializer, storage, onError]);
   const updateState = useEvent(
     (valOrFunc) => {
       const currentState = isFunction(valOrFunc) ? valOrFunc(state) : valOrFunc;
@@ -253,7 +296,9 @@ function useDarkMode(options = {}) {
   } = options;
   const prefersDarkMode = usePreferredDark(false);
   const value = initialValue ? initialValue : prefersDarkMode ? "dark" : "light";
-  const [dark, setDark] = useStorage(storageKey, value, storage);
+  const [dark, setDark] = useStorage(storageKey, value, storage, {
+    ignoreDefaults: false
+  });
   const wrappedSetDark = useCallback(
     (latestDark) => {
       const element = window == null ? void 0 : window.document.querySelector(selector);
@@ -501,49 +546,6 @@ function useLatestElement(target, defaultElement) {
   return ref;
 }
 
-const isPrimitive$1 = (val) => val !== Object(val);
-function useCustomCompareEffect(effect, deps, depsEqual) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!(deps instanceof Array) || !deps.length) {
-      console.warn(
-        "`useCustomCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
-      );
-    }
-    if (deps.every(isPrimitive$1)) {
-      console.warn(
-        "`useCustomCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
-      );
-    }
-    if (typeof depsEqual !== "function") {
-      console.warn(
-        "`useCustomCompareEffect` should be used with depsEqual callback for comparing deps list"
-      );
-    }
-  }
-  const ref = useRef(void 0);
-  if (!ref.current || !depsEqual(deps, ref.current)) {
-    ref.current = deps;
-  }
-  useEffect(effect, ref.current);
-}
-
-const isPrimitive = (val) => val !== Object(val);
-function useDeepCompareEffect(effect, deps) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!(deps instanceof Array) || !deps.length) {
-      console.warn(
-        "`useDeepCompareEffect` should not be used with no dependencies. Use React.useEffect instead."
-      );
-    }
-    if (deps.every(isPrimitive)) {
-      console.warn(
-        "`useDeepCompareEffect` should not be used with dependencies that are all primitive values. Use React.useEffect instead."
-      );
-    }
-  }
-  useCustomCompareEffect(effect, deps, isEqual);
-}
-
 function useEventListener(eventName, handler, element, options) {
   const savedHandler = useLatest(handler);
   const targetElementRef = useLatestElement(element, defaultWindow);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactuses/core",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",