@oneplatformdev/hooks 0.1.0-11 → 0.1.0-13

package/dist/useTernaryDarkMode/useTernaryDarkMode.js

@@ -0,0 +1,27 @@
+import { useLocalStorage as c } from "../useLocalStorage/useLocalStorage.js";
+import { useMediaQuery as m } from "../useMediaQuery/useMediaQuery.js";
+const y = "(prefers-color-scheme: dark)", M = "usehooks-ts-ternary-dark-mode";
+function f({
+  defaultValue: t = "system",
+  localStorageKey: n = M,
+  initializeWithValue: o = !0
+} = {}) {
+  const a = m(y, { initializeWithValue: o }), [e, s] = c(n, t, {
+    initializeWithValue: o
+  });
+  return {
+    isDarkMode: e === "dark" || e === "system" && a,
+    ternaryDarkMode: e,
+    setTernaryDarkMode: s,
+    toggleTernaryDarkMode: () => {
+      const r = ["light", "system", "dark"];
+      s((d) => {
+        const k = (r.indexOf(d) + 1) % r.length;
+        return r[k];
+      });
+    }
+  };
+}
+export {
+  f as useTernaryDarkMode
+};

package/dist/useTimeout/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useTimeout';
+//# sourceMappingURL=index.d.ts.map

package/dist/useTimeout/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useTimeout/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/useTimeout/index.js

@@ -0,0 +1,4 @@
+import { useTimeout as m } from "./useTimeout.js";
+export {
+  m as useTimeout
+};

package/dist/useTimeout/useTimeout.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Custom hook that handles timeouts in React components using the [`setTimeout API`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout).
+ * @param {() => void} callback - The function to be executed when the timeout elapses.
+ * @param {number | null} delay - The duration (in milliseconds) for the timeout. Set to `null` to clear the timeout.
+ * @returns {void} This hook does not return anything.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-timeout)
+ * @example
+ * ```tsx
+ * // Usage of useTimeout hook
+ * useTimeout(() => {
+ *   // Code to be executed after the specified delay
+ * }, 1000); // Set a timeout of 1000 milliseconds (1 second)
+ * ```
+ */
+export declare function useTimeout(callback: () => void, delay: number | null): void;
+//# sourceMappingURL=useTimeout.d.ts.map

package/dist/useTimeout/useTimeout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTimeout.d.ts","sourceRoot":"","sources":["../../src/useTimeout/useTimeout.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAwB3E"}

package/dist/useTimeout/useTimeout.js

@@ -0,0 +1,20 @@
+import { useRef as u, useEffect as f } from "react";
+import { useIsomorphicLayoutEffect as i } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";
+function n(e, t) {
+  const r = u(e);
+  i(() => {
+    r.current = e;
+  }, [e]), f(() => {
+    if (!t && t !== 0)
+      return;
+    const o = setTimeout(() => {
+      r.current();
+    }, t);
+    return () => {
+      clearTimeout(o);
+    };
+  }, [t]);
+}
+export {
+  n as useTimeout
+};

package/dist/useToggle/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useToggle';
+//# sourceMappingURL=index.d.ts.map

package/dist/useToggle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useToggle/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA"}

package/dist/useToggle/index.js

@@ -0,0 +1,4 @@
+import { useToggle as g } from "./useToggle.js";
+export {
+  g as useToggle
+};

package/dist/useToggle/useToggle.d.ts

@@ -0,0 +1,18 @@
+import { Dispatch, SetStateAction } from 'react';
+/**
+ * Custom hook that manages a boolean toggle state in React components.
+ * @param {boolean} [defaultValue] - The initial value for the toggle state.
+ * @returns {[boolean, () => void, Dispatch<SetStateAction<boolean>>]} A tuple containing the current state,
+ * a function to toggle the state, and a function to set the state explicitly.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-toggle)
+ * @example
+ * ```tsx
+ * const [isToggled, toggle, setToggle] = useToggle(); // Initial value is false
+ * // OR
+ * const [isToggled, toggle, setToggle] = useToggle(true); // Initial value is true
+ * // Use isToggled in your component, toggle to switch the state, setToggle to set the state explicitly.
+ * ```
+ */
+export declare function useToggle(defaultValue?: boolean): [boolean, () => void, Dispatch<SetStateAction<boolean>>];
+//# sourceMappingURL=useToggle.d.ts.map

package/dist/useToggle/useToggle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useToggle.d.ts","sourceRoot":"","sources":["../../src/useToggle/useToggle.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAErD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,YAAY,CAAC,EAAE,OAAO,GACrB,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAQ1D"}

package/dist/useToggle/useToggle.js

@@ -0,0 +1,10 @@
+import { useState as s, useCallback as a } from "react";
+function r(t) {
+  const [o, e] = s(!!t), u = a(() => {
+    e((l) => !l);
+  }, []);
+  return [o, u, e];
+}
+export {
+  r as useToggle
+};

package/dist/useUnmount/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useUnmount';
+//# sourceMappingURL=index.d.ts.map

package/dist/useUnmount/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useUnmount/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/useUnmount/index.js

@@ -0,0 +1,4 @@
+import { useUnmount as m } from "./useUnmount.js";
+export {
+  m as useUnmount
+};

package/dist/useUnmount/useUnmount.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Custom hook that runs a cleanup function when the component is unmounted.
+ * @param {() => void} func - The cleanup function to be executed on unmount.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-unmount)
+ * @example
+ * ```tsx
+ * useUnmount(() => {
+ *   // Cleanup logic here
+ * });
+ * ```
+ */
+export declare function useUnmount(func: () => void): void;
+//# sourceMappingURL=useUnmount.d.ts.map

package/dist/useUnmount/useUnmount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUnmount.d.ts","sourceRoot":"","sources":["../../src/useUnmount/useUnmount.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,IAAI,QAW1C"}

package/dist/useUnmount/useUnmount.js

@@ -0,0 +1,13 @@
+import { useRef as n, useEffect as r } from "react";
+function f(e) {
+  const t = n(e);
+  t.current = e, r(
+    () => () => {
+      t.current();
+    },
+    []
+  );
+}
+export {
+  f as useUnmount
+};

package/dist/useWindowSize/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useWindowSize';
+//# sourceMappingURL=index.d.ts.map

package/dist/useWindowSize/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useWindowSize/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}

package/dist/useWindowSize/index.js

@@ -0,0 +1,4 @@
+import { useWindowSize as i } from "./useWindowSize.js";
+export {
+  i as useWindowSize
+};

package/dist/useWindowSize/useWindowSize.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Represent the dimension of the window.
+ * @template T - The type of the dimension (number or undefined).
+ */
+type WindowSize<T extends number | undefined = number | undefined> = {
+    /** The width of the window. */
+    width: T;
+    /** The height of the window. */
+    height: T;
+};
+/**
+ * Hook options.
+ * @template InitializeWithValue - If `true` (default), the hook will initialize reading the window size. In SSR, you should set it to `false`, returning `undefined` initially.
+ */
+type UseWindowSizeOptions<InitializeWithValue extends boolean | undefined> = {
+    /**
+     * If `true` (default), the hook will initialize reading the window size. In SSR, you should set it to `false`, returning `undefined` initially.
+     * @default true
+     */
+    initializeWithValue: InitializeWithValue;
+    /**
+     * The delay in milliseconds before the state is updated (disabled by default for retro-compatibility).
+     * @default undefined
+     */
+    debounceDelay?: number;
+};
+export declare function useWindowSize(options: UseWindowSizeOptions<false>): WindowSize;
+export declare function useWindowSize(options?: Partial<UseWindowSizeOptions<true>>): WindowSize<number>;
+export {};
+//# sourceMappingURL=useWindowSize.d.ts.map

package/dist/useWindowSize/useWindowSize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWindowSize.d.ts","sourceRoot":"","sources":["../../src/useWindowSize/useWindowSize.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IAAI;IACnE,+BAA+B;IAC/B,KAAK,EAAE,CAAC,CAAA;IACR,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAA;CACV,CAAA;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,mBAAmB,SAAS,OAAO,GAAG,SAAS,IAAI;IAC3E;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAKD,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAA;AAE/E,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,GAC5C,UAAU,CAAC,MAAM,CAAC,CAAA"}

package/dist/useWindowSize/useWindowSize.js

@@ -0,0 +1,31 @@
+import { useState as r } from "react";
+import { useDebounceCallback as u } from "../useDebounceCallback/useDebounceCallback.js";
+import { useEventListener as w } from "../useEventListener/useEventListener.js";
+import { useIsomorphicLayoutEffect as h } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";
+const s = typeof window > "u";
+function m(e = {}) {
+  let { initializeWithValue: i = !0 } = e;
+  s && (i = !1);
+  const [o, t] = r(() => i ? {
+    width: window.innerWidth,
+    height: window.innerHeight
+  } : {
+    width: void 0,
+    height: void 0
+  }), d = u(
+    t,
+    e.debounceDelay
+  );
+  function n() {
+    (e.debounceDelay ? d : t)({
+      width: window.innerWidth,
+      height: window.innerHeight
+    });
+  }
+  return w("resize", n), h(() => {
+    n();
+  }, []), o;
+}
+export {
+  m as useWindowSize
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneplatformdev/hooks",
-  "version": "0.1.0-11",
+  "version": "0.1.0-13",
   "description": "React hook library",
   "author": "One Platform Development Team",
   "keywords": [
@@ -38,14 +38,10 @@
       "default": "./*.js"
     }
   },
-  "publishConfig": {
-    "directory": "dist"
-  },
   "files": [
     "dist",
     "README.md",
     "LICENSE",
-    "package.json",
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {