@oneplatformdev/hooks 0.0.1-beta.6 → 0.1.1-1

package/useTernaryDarkMode/useTernaryDarkMode.d.ts

@@ -1,46 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-
-/** Ternary dark mode options. */
-export type TernaryDarkMode = 'system' | 'dark' | 'light';
-/** Options for the `useTernaryDarkMode` hook. */
-export type TernaryDarkModeOptions = {
-    /**
-     * The default value for the dark mode.
-     * @default 'system'
-     */
-    defaultValue?: TernaryDarkMode;
-    /**
-     * The key for storing dark mode preference in local storage.
-     * @default 'usehooks-ts-ternary-dark-mode'
-     */
-    localStorageKey?: string;
-    /**
-     * If `true` (default), the hook will initialize reading `localStorage`. In SSR, you should set it to `false`, returning default values initially.
-     * @default true
-     */
-    initializeWithValue?: boolean;
-};
-/** Represents the return type of the `useTernaryDarkMode` hook. */
-export type TernaryDarkModeReturn = {
-    /** The current state of the dark mode. */
-    isDarkMode: boolean;
-    /** The current state of the dark mode. */
-    ternaryDarkMode: TernaryDarkMode;
-    /** A function to set the dark mode state. */
-    setTernaryDarkMode: Dispatch<SetStateAction<TernaryDarkMode>>;
-    /** A function to toggle the dark mode state. */
-    toggleTernaryDarkMode: () => void;
-};
-/**
- * Custom hook that manages ternary (system, dark, light) dark mode with local storage support.
- * @param {?TernaryDarkModeOptions | string} [options] - Options or the local storage key for the hook.
- * @returns {TernaryDarkModeReturn} An object containing the dark mode state and helper functions.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-ternary-dark-mode)
- * @example
- * ```tsx
- * const { isDarkMode, ternaryDarkMode, setTernaryDarkMode, toggleTernaryDarkMode } = useTernaryDarkMode({ defaultValue: 'dark' });
- * // Access and use the dark mode state and provided helper functions.
- * ```
- */
-export declare function useTernaryDarkMode({ defaultValue, localStorageKey, initializeWithValue, }?: TernaryDarkModeOptions): TernaryDarkModeReturn;

package/useTernaryDarkMode/useTernaryDarkMode.mjs

@@ -1,27 +0,0 @@
-import { useLocalStorage as c } from "../useLocalStorage/useLocalStorage.mjs";
-import { useMediaQuery as m } from "../useMediaQuery/useMediaQuery.mjs";
-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/useTimeout/index.d.ts

@@ -1 +0,0 @@
-export * from './useTimeout';

package/useTimeout/index.mjs

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

package/useTimeout/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useTimeout/useTimeout.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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;

package/useTimeout/useTimeout.mjs

@@ -1,20 +0,0 @@
-import { useRef as u, useEffect as f } from "react";
-import { useIsomorphicLayoutEffect as i } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs";
-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/useToggle/index.d.ts

@@ -1 +0,0 @@
-export * from './useToggle';

package/useToggle/index.mjs

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

package/useToggle/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useToggle/useToggle.d.ts

@@ -1,18 +0,0 @@
-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>>];

package/useToggle/useToggle.mjs

@@ -1,10 +0,0 @@
-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/useUnmount/index.d.ts

@@ -1 +0,0 @@
-export * from './useUnmount';

package/useUnmount/index.mjs

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

package/useUnmount/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useUnmount/useUnmount.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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;

package/useUnmount/useUnmount.mjs

@@ -1,13 +0,0 @@
-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/useWindowSize/index.d.ts

@@ -1 +0,0 @@
-export * from './useWindowSize';

package/useWindowSize/index.mjs

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

package/useWindowSize/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useWindowSize/useWindowSize.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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 {};

package/useWindowSize/useWindowSize.mjs

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