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

package/useInterval/useInterval.mjs

@@ -1,20 +0,0 @@
-import { useRef as o, useEffect as u } from "react";
-import { useIsomorphicLayoutEffect as f } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs";
-function i(r, t) {
-  const e = o(r);
-  f(() => {
-    e.current = r;
-  }, [r]), u(() => {
-    if (t === null)
-      return;
-    const n = setInterval(() => {
-      e.current();
-    }, t);
-    return () => {
-      clearInterval(n);
-    };
-  }, [t]);
-}
-export {
-  i as useInterval
-};

package/useIsClient/index.d.ts

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

package/useIsClient/index.mjs

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

package/useIsClient/package.json

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

package/useIsClient/useIsClient.d.ts

@@ -1,12 +0,0 @@
-/**
- * Custom hook that determines if the code is running on the client side (in the browser).
- * @returns {boolean} A boolean value indicating whether the code is running on the client side.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-is-client)
- * @example
- * ```tsx
- * const isClient = useIsClient();
- * // Use isClient to conditionally render or execute code specific to the client side.
- * ```
- */
-export declare function useIsClient(): boolean;

package/useIsClient/useIsClient.mjs

@@ -1,10 +0,0 @@
-import { useState as s, useEffect as n } from "react";
-function r() {
-  const [e, t] = s(!1);
-  return n(() => {
-    t(!0);
-  }, []), e;
-}
-export {
-  r as useIsClient
-};

package/useIsMobile/index.d.ts

@@ -1,2 +0,0 @@
-export * from './useIsMobile';
-export type * from './types';

package/useIsMobile/index.mjs

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

package/useIsMobile/package.json

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

package/useIsMobile/types.d.ts

@@ -1,3 +0,0 @@
-export interface IUseIsMobileParams {
-    mobileBreakpoint?: number;
-}

package/useIsMobile/types.mjs

@@ -1 +0,0 @@
-

package/useIsMobile/useIsMobile.d.ts

@@ -1,3 +0,0 @@
-import { IUseIsMobileParams } from './types';
-
-export declare function useIsMobile(params?: IUseIsMobileParams): boolean;

package/useIsMobile/useIsMobile.mjs

@@ -1,16 +0,0 @@
-import * as o from "react";
-const a = 768;
-function c(s = {}) {
-  const {
-    mobileBreakpoint: e = a
-  } = s, [r, n] = o.useState(void 0);
-  return o.useEffect(() => {
-    const t = window.matchMedia(`(max-width: ${e - 1}px)`), i = () => {
-      n(window.innerWidth < e);
-    };
-    return t.addEventListener("change", i), n(window.innerWidth < e), () => t.removeEventListener("change", i);
-  }, [e]), !!r;
-}
-export {
-  c as useIsMobile
-};

package/useIsMounted/index.d.ts

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

package/useIsMounted/index.mjs

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

package/useIsMounted/package.json

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

package/useIsMounted/useIsMounted.d.ts

@@ -1 +0,0 @@
-export declare function useIsMounted(): () => boolean;

package/useIsMounted/useIsMounted.mjs

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

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

package/useIsomorphicLayoutEffect/index.mjs

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

package/useIsomorphicLayoutEffect/package.json

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

package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts

@@ -1,16 +0,0 @@
-import { useLayoutEffect } from 'react';
-
-/**
- * Custom hook that uses either `useLayoutEffect` or `useEffect` based on the environment (client-side or server-side).
- * @param {Function} effect - The effect function to be executed.
- * @param {Array<any>} [dependencies] - An array of dependencies for the effect (optional).
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-isomorphic-layout-effect)
- * @example
- * ```tsx
- * useIsomorphicLayoutEffect(() => {
- *   // Code to be executed during the layout phase on the client side
- * }, [dependency1, dependency2]);
- * ```
- */
-export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;

package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs

@@ -1,5 +0,0 @@
-import { useLayoutEffect as e, useEffect as o } from "react";
-const t = typeof window < "u" ? e : o;
-export {
-  t as useIsomorphicLayoutEffect
-};

package/useLocalStorage/index.d.ts

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

package/useLocalStorage/index.mjs

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

package/useLocalStorage/package.json

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

package/useLocalStorage/useLocalStorage.d.ts

@@ -1,39 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-
-declare global {
-    interface WindowEventMap {
-        'local-storage': CustomEvent;
-    }
-}
-/**
- * Options for customizing the behavior of serialization and deserialization.
- * @template T - The type of the state to be stored in local storage.
- */
-type UseLocalStorageOptions<T> = {
-    /** A function to serialize the value before storing it. */
-    serializer?: (value: T) => string;
-    /** A function to deserialize the stored value. */
-    deserializer?: (value: string) => T;
-    /**
-     * If `true` (default), the hook will initialize reading the local storage. In SSR, you should set it to `false`, returning the initial value initially.
-     * @default true
-     */
-    initializeWithValue?: boolean;
-};
-/**
- * Custom hook that uses the [`localStorage API`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) to persist state across page reloads.
- * @template T - The type of the state to be stored in local storage.
- * @param {string} key - The key under which the value will be stored in local storage.
- * @param {T | (() => T)} initialValue - The initial value of the state or a function that returns the initial value.
- * @param {UseLocalStorageOptions<T>} [options] - Options for customizing the behavior of serialization and deserialization (optional).
- * @returns {[T, Dispatch<SetStateAction<T>>, () => void]} A tuple containing the stored value, a function to set the value and a function to remove the key from storage.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-local-storage)
- * @example
- * ```tsx
- * const [count, setCount, removeCount] = useLocalStorage('count', 0);
- * // Access the `count` value, the `setCount` function to update it and `removeCount` function to remove the key from storage.
- * ```
- */
-export declare function useLocalStorage<T>(key: string, initialValue: T | (() => T), options?: UseLocalStorageOptions<T>): [T, Dispatch<SetStateAction<T>>, () => void];
-export {};

package/useLocalStorage/useLocalStorage.mjs

@@ -1,65 +0,0 @@
-import { useCallback as a, useState as z, useEffect as F } from "react";
-import { useEventCallback as i } from "../useEventCallback/useEventCallback.mjs";
-import { useEventListener as l } from "../useEventListener/useEventListener.mjs";
-const d = typeof window > "u";
-function C(t, r, o = {}) {
-  const { initializeWithValue: w = !0 } = o, S = a(
-    (e) => o.serializer ? o.serializer(e) : JSON.stringify(e),
-    [o]
-  ), f = a(
-    (e) => {
-      if (o.deserializer)
-        return o.deserializer(e);
-      if (e === "undefined")
-        return;
-      const n = r instanceof Function ? r() : r;
-      let u;
-      try {
-        u = JSON.parse(e);
-      } catch (v) {
-        return console.error("Error parsing JSON:", v), n;
-      }
-      return u;
-    },
-    [o, r]
-  ), c = a(() => {
-    const e = r instanceof Function ? r() : r;
-    if (d)
-      return e;
-    try {
-      const n = window.localStorage.getItem(t);
-      return n ? f(n) : e;
-    } catch (n) {
-      return console.warn(`Error reading localStorage key “${t}”:`, n), e;
-    }
-  }, [r, t, f]), [m, s] = z(() => w ? c() : r instanceof Function ? r() : r), h = i((e) => {
-    d && console.warn(
-      `Tried setting localStorage key “${t}” even though environment is not a client`
-    );
-    try {
-      const n = e instanceof Function ? e(c()) : e;
-      window.localStorage.setItem(t, S(n)), s(n), window.dispatchEvent(new StorageEvent("local-storage", { key: t }));
-    } catch (n) {
-      console.warn(`Error setting localStorage key “${t}”:`, n);
-    }
-  }), E = i(() => {
-    d && console.warn(
-      `Tried removing localStorage key “${t}” even though environment is not a client`
-    );
-    const e = r instanceof Function ? r() : r;
-    window.localStorage.removeItem(t), s(e), window.dispatchEvent(new StorageEvent("local-storage", { key: t }));
-  });
-  F(() => {
-    s(c());
-  }, [t]);
-  const g = a(
-    (e) => {
-      e.key && e.key !== t || s(c());
-    },
-    [t, c]
-  );
-  return l("storage", g), l("local-storage", g), [m, h, E];
-}
-export {
-  C as useLocalStorage
-};

package/useLockBody/index.d.ts

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

package/useLockBody/index.mjs

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

package/useLockBody/package.json

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

package/useLockBody/useLockBody.d.ts

@@ -1 +0,0 @@
-export declare function useLockBody(): void;

package/useLockBody/useLockBody.mjs

@@ -1,12 +0,0 @@
-import * as e from "react";
-function t() {
-  e.useLayoutEffect(() => {
-    const o = window.getComputedStyle(
-      document.body
-    ).overflow;
-    return document.body.style.overflow = "hidden", () => document.body.style.overflow = o;
-  }, []);
-}
-export {
-  t as useLockBody
-};

package/useMap/index.d.ts

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

package/useMap/index.mjs

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

package/useMap/package.json

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

package/useMap/useMap.d.ts

@@ -1,47 +0,0 @@
-/**
- * Represents the type for either a Map or an array of key-value pairs.
- * @template K - The type of keys in the map.
- * @template V - The type of values in the map.
- */
-type MapOrEntries<K, V> = Map<K, V> | [K, V][];
-/**
- * Represents the actions available to interact with the map state.
- * @template K - The type of keys in the map.
- * @template V - The type of values in the map.
- */
-type UseMapActions<K, V> = {
-    /** Set a key-value pair in the map. */
-    set: (key: K, value: V) => void;
-    /** Set all key-value pairs in the map. */
-    setAll: (entries: MapOrEntries<K, V>) => void;
-    /** Remove a key-value pair from the map. */
-    remove: (key: K) => void;
-    /** Reset the map to an empty state. */
-    reset: Map<K, V>['clear'];
-};
-/**
- * Represents the return type of the `useMap` hook.
- * We hide some setters from the returned map to disable autocompletion.
- * @template K - The type of keys in the map.
- * @template V - The type of values in the map.
- */
-type UseMapReturn<K, V> = [
-    Omit<Map<K, V>, 'set' | 'clear' | 'delete'>,
-    UseMapActions<K, V>
-];
-/**
- * Custom hook that manages a key-value [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) state with setter actions.
- * @template K - The type of keys in the map.
- * @template V - The type of values in the map.
- * @param {MapOrEntries<K, V>} [initialState] - The initial state of the map as a Map or an array of key-value pairs (optional).
- * @returns {UseMapReturn<K, V>} A tuple containing the map state and actions to interact with the map.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-map)
- * @example
- * ```tsx
- * const [map, mapActions] = useMap();
- * // Access the `map` state and use `mapActions` to set, remove, or reset entries.
- * ```
- */
-export declare function useMap<K, V>(initialState?: MapOrEntries<K, V>): UseMapReturn<K, V>;
-export {};

package/useMap/useMap.mjs

@@ -1,27 +0,0 @@
-import { useState as M, useCallback as a } from "react";
-function w(o = /* @__PURE__ */ new Map()) {
-  const [r, t] = M(new Map(o)), c = {
-    set: a((e, p) => {
-      t((n) => {
-        const s = new Map(n);
-        return s.set(e, p), s;
-      });
-    }, []),
-    setAll: a((e) => {
-      t(() => new Map(e));
-    }, []),
-    remove: a((e) => {
-      t((p) => {
-        const n = new Map(p);
-        return n.delete(e), n;
-      });
-    }, []),
-    reset: a(() => {
-      t(() => /* @__PURE__ */ new Map());
-    }, [])
-  };
-  return [r, c];
-}
-export {
-  w as useMap
-};

package/useMediaQuery/index.d.ts

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

package/useMediaQuery/index.mjs

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

package/useMediaQuery/package.json

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

package/useMediaQuery/useMediaQuery.d.ts

@@ -1,28 +0,0 @@
-/** Hook options. */
-type UseMediaQueryOptions = {
-    /**
-     * The default value to return if the hook is being run on the server.
-     * @default false
-     */
-    defaultValue?: boolean;
-    /**
-     * If `true` (default), the hook will initialize reading the media query. In SSR, you should set it to `false`, returning `options.defaultValue` or `false` initially.
-     * @default true
-     */
-    initializeWithValue?: boolean;
-};
-/**
- * Custom hook that tracks the state of a media query using the [`Match Media API`](https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia).
- * @param {string} query - The media query to track.
- * @param {?UseMediaQueryOptions} [options] - The options for customizing the behavior of the hook (optional).
- * @returns {boolean} The current state of the media query (true if the query matches, false otherwise).
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-media-query)
- * @example
- * ```tsx
- * const isSmallScreen = useMediaQuery('(max-width: 600px)');
- * // Use `isSmallScreen` to conditionally apply styles or logic based on the screen size.
- * ```
- */
-export declare function useMediaQuery(query: string, { defaultValue, initializeWithValue, }?: UseMediaQueryOptions): boolean;
-export {};

package/useMediaQuery/useMediaQuery.mjs

@@ -1,21 +0,0 @@
-import { useState as c } from "react";
-import { useIsomorphicLayoutEffect as d } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs";
-const m = typeof window > "u";
-function u(n, {
-  defaultValue: r = !1,
-  initializeWithValue: s = !0
-} = {}) {
-  const i = (e) => m ? r : window.matchMedia(e).matches, [o, a] = c(() => s ? i(n) : r);
-  function t() {
-    a(i(n));
-  }
-  return d(() => {
-    const e = window.matchMedia(n);
-    return t(), e.addListener ? e.addListener(t) : e.addEventListener("change", t), () => {
-      e.removeListener ? e.removeListener(t) : e.removeEventListener("change", t);
-    };
-  }, [n]), o;
-}
-export {
-  u as useMediaQuery
-};

package/useOnClickOutside/index.d.ts

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

package/useOnClickOutside/index.mjs

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

package/useOnClickOutside/package.json

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

package/useOnClickOutside/useOnClickOutside.d.ts

@@ -1,24 +0,0 @@
-import { RefObject } from 'react';
-
-/** Supported event types. */
-type EventType = 'mousedown' | 'mouseup' | 'touchstart' | 'touchend' | 'focusin' | 'focusout';
-/**
- * Custom hook that handles clicks outside a specified element.
- * @template T - The type of the element's reference.
- * @param {RefObject<T> | RefObject<T>[]} ref - The React ref object(s) representing the element(s) to watch for outside clicks.
- * @param {(event: MouseEvent | TouchEvent | FocusEvent) => void} handler - The callback function to be executed when a click outside the element occurs.
- * @param {EventType} [eventType] - The mouse event type to listen for (optional, default is 'mousedown').
- * @param {?AddEventListenerOptions} [eventListenerOptions] - The options object to be passed to the `addEventListener` method (optional).
- * @returns {void}
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-on-click-outside)
- * @example
- * ```tsx
- * const containerRef = useRef(null);
- * useOnClickOutside([containerRef], () => {
- *   // Handle clicks outside the container.
- * });
- * ```
- */
-export declare function useOnClickOutside<T extends HTMLElement = HTMLElement>(ref: RefObject<T> | RefObject<T>[], handler: (event: MouseEvent | TouchEvent | FocusEvent) => void, eventType?: EventType, eventListenerOptions?: AddEventListenerOptions): void;
-export {};

package/useOnClickOutside/useOnClickOutside.mjs

@@ -1,17 +0,0 @@
-import { useEventListener as o } from "../useEventListener/useEventListener.mjs";
-function d(t, i, s = "mousedown", u = {}) {
-  o(
-    s,
-    (r) => {
-      const n = r.target;
-      if (!n || !n.isConnected)
-        return;
-      (Array.isArray(t) ? t.filter((e) => !!e.current).every((e) => e.current && !e.current.contains(n)) : t.current && !t.current.contains(n)) && i(r);
-    },
-    void 0,
-    u
-  );
-}
-export {
-  d as useOnClickOutside
-};

package/useReadLocalStorage/index.d.ts

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

package/useReadLocalStorage/index.mjs

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

package/useReadLocalStorage/package.json

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

package/useReadLocalStorage/useReadLocalStorage.d.ts

@@ -1,13 +0,0 @@
-/**
- * Represents the type for the options available when reading from local storage.
- * @template T - The type of the stored value.
- */
-type Options<T, InitializeWithValue extends boolean | undefined> = {
-    /** Custom deserializer function to convert the stored string value to the desired type (optional). */
-    deserializer?: (value: string) => T;
-    /** If `true` (default), the hook will initialize reading the local storage. In SSR, you should set it to `false`, returning `undefined` initially. */
-    initializeWithValue: InitializeWithValue;
-};
-export declare function useReadLocalStorage<T>(key: string, options: Options<T, false>): T | null | undefined;
-export declare function useReadLocalStorage<T>(key: string, options?: Partial<Options<T, true>>): T | null;
-export {};