@siberiacancode/reactuse 0.0.11 → 0.0.13

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
-export{useBattery}from"./hooks/useBattery/useBattery.js";export{useBoolean}from"./hooks/useBoolean/useBoolean.js";export{useClickOutside}from"./hooks/useClickOutside/useClickOutside.js";export{legacyCopyToClipboard,useCopyToClipboard}from"./hooks/useCopyToClipboard/useCopyToClipboard.js";export{useCounter}from"./hooks/useCounter/useCounter.js";export{useDebouncedValue}from"./hooks/useDebouncedValue/useDebouncedValue.js";export{useDefault}from"./hooks/useDefault/useDefault.js";export{useDidUpdate}from"./hooks/useDidUpdate/useDidUpdate.js";export{useDocumentTitle}from"./hooks/useDocumentTitle/useDocumentTitle.js";export{useDocumentVisibility}from"./hooks/useDocumentVisibility/useDocumentVisibility.js";export{useEvent}from"./hooks/useEvent/useEvent.js";export{useEventListener}from"./hooks/useEventListener/useEventListener.js";export{useFavicon}from"./hooks/useFavicon/useFavicon.js";export{useHash}from"./hooks/useHash/useHash.js";export{isHotkeyMatch,useHotkeys}from"./hooks/useHotkeys/useHotkeys.js";export{useHover}from"./hooks/useHover/useHover.js";export{useIdle}from"./hooks/useIdle/useIdle.js";export{useIntersectionObserver}from"./hooks/useIntersectionObserver/useIntersectionObserver.js";export{useIsomorphicLayoutEffect}from"./hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";export{useKeyPress}from"./hooks/useKeyPress/useKeyPress.js";export{useKeyPressEvent}from"./hooks/useKeyPressEvent/useKeyPressEvent.js";export{useKeysPressed}from"./hooks/useKeysPressed/useKeysPressed.js";export{useLocalStorage}from"./hooks/useLocalStorage/useLocalStorage.js";export{useLogger}from"./hooks/useLogger/useLogger.js";export{useMediaQuery}from"./hooks/useMediaQuery/useMediaQuery.js";export{useMount}from"./hooks/useMount/useMount.js";export{getConnection,useNetwork}from"./hooks/useNetwork/useNetwork.js";export{useOnline}from"./hooks/useOnline/useOnline.js";export{getOperatingSystem,useOperatingSystem}from"./hooks/useOperatingSystem/useOperatingSystem.js";export{useOrientation}from"./hooks/useOrientation/useOrientation.js";export{usePrevious}from"./hooks/usePrevious/usePrevious.js";export{useQueue}from"./hooks/useQueue/useQueue.js";export{useRenderCount}from"./hooks/useRenderCount/useRenderCount.js";export{useRerender}from"./hooks/useRerender/useRerender.js";export{SCRIPT_STATUS_ATTRIBUTE_NAME,useScript}from"./hooks/useScript/useScript.js";export{useSessionStorage}from"./hooks/useSessionStorage/useSessionStorage.js";export{useSet}from"./hooks/useSet/useSet.js";export{useStep}from"./hooks/useStep/useStep.js";export{dispatchStorageEvent,useStorage}from"./hooks/useStorage/useStorage.js";export{useTimeout}from"./hooks/useTimeout/useTimeout.js";export{useToggle}from"./hooks/useToggle/useToggle.js";export{useUnmount}from"./hooks/useUnmount/useUnmount.js";export{useWindowEvent}from"./hooks/useWindowEvent/useWindowEvent.js";export{useWindowSize}from"./hooks/useWindowSize/useWindowSize.js";import"./_rollupPluginBabelHelpers-TF5Io098.js";import"react";import"./utils/helpers/debounce.js";import"./utils/helpers/isClient.js";import"./hooks/useMutationObserver.js";import"./utils/helpers/throttle.js";import"./utils/helpers/isShallowEqual.js";
+/* @license @siberiacancode/reactuse v0.0.13 */
+export{useBattery}from"./hooks/useBattery/useBattery.js";export{useBoolean}from"./hooks/useBoolean/useBoolean.js";export{useClickOutside}from"./hooks/useClickOutside/useClickOutside.js";export{legacyCopyToClipboard,useCopyToClipboard}from"./hooks/useCopyToClipboard/useCopyToClipboard.js";export{useCounter}from"./hooks/useCounter/useCounter.js";export{useDebouncedValue}from"./hooks/useDebouncedValue/useDebouncedValue.js";export{useDefault}from"./hooks/useDefault/useDefault.js";export{useDidUpdate}from"./hooks/useDidUpdate/useDidUpdate.js";export{useDocumentTitle}from"./hooks/useDocumentTitle/useDocumentTitle.js";export{useDocumentVisibility}from"./hooks/useDocumentVisibility/useDocumentVisibility.js";export{useEvent}from"./hooks/useEvent/useEvent.js";export{useEventListener}from"./hooks/useEventListener/useEventListener.js";export{useFavicon}from"./hooks/useFavicon/useFavicon.js";export{useHash}from"./hooks/useHash/useHash.js";export{isHotkeyMatch,useHotkeys}from"./hooks/useHotkeys/useHotkeys.js";export{useHover}from"./hooks/useHover/useHover.js";export{useIdle}from"./hooks/useIdle/useIdle.js";export{useIntersectionObserver}from"./hooks/useIntersectionObserver/useIntersectionObserver.js";export{useIsFirstRender}from"./hooks/useIsFirstRender/useIsFirstRender.js";export{useIsomorphicLayoutEffect}from"./hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";export{useKeyPress}from"./hooks/useKeyPress/useKeyPress.js";export{useKeyPressEvent}from"./hooks/useKeyPressEvent/useKeyPressEvent.js";export{useKeysPressed}from"./hooks/useKeysPressed/useKeysPressed.js";export{useLocalStorage}from"./hooks/useLocalStorage/useLocalStorage.js";export{useLogger}from"./hooks/useLogger/useLogger.js";export{useMediaQuery}from"./hooks/useMediaQuery/useMediaQuery.js";export{useMount}from"./hooks/useMount/useMount.js";export{getConnection,useNetwork}from"./hooks/useNetwork/useNetwork.js";export{useOnline}from"./hooks/useOnline/useOnline.js";export{getOperatingSystem,useOperatingSystem}from"./hooks/useOperatingSystem/useOperatingSystem.js";export{useOrientation}from"./hooks/useOrientation/useOrientation.js";export{usePageLeave}from"./hooks/usePageLeave/usePageLeave.js";export{usePrevious}from"./hooks/usePrevious/usePrevious.js";export{useQueue}from"./hooks/useQueue/useQueue.js";export{useRenderCount}from"./hooks/useRenderCount/useRenderCount.js";export{useRerender}from"./hooks/useRerender/useRerender.js";export{SCRIPT_STATUS_ATTRIBUTE_NAME,useScript}from"./hooks/useScript/useScript.js";export{useSessionStorage}from"./hooks/useSessionStorage/useSessionStorage.js";export{useSet}from"./hooks/useSet/useSet.js";export{useStep}from"./hooks/useStep/useStep.js";export{dispatchStorageEvent,useStorage}from"./hooks/useStorage/useStorage.js";export{useTimeout}from"./hooks/useTimeout/useTimeout.js";export{useToggle}from"./hooks/useToggle/useToggle.js";export{useUnmount}from"./hooks/useUnmount/useUnmount.js";export{useWindowEvent}from"./hooks/useWindowEvent/useWindowEvent.js";export{useWindowSize}from"./hooks/useWindowSize/useWindowSize.js";import"./_rollupPluginBabelHelpers-CtMKhJ6X.js";import"react";import"./utils/helpers/debounce.js";import"./utils/helpers/isClient.js";import"./hooks/useMutationObserver.js";import"./utils/helpers/throttle.js";import"./utils/helpers/isShallowEqual.js";import"./index-Dl6lmkQE.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/utils/helpers/debounce.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
+/* @license @siberiacancode/reactuse v0.0.13 */
 var r=function(r,n){var t;return function(){for(var e=arguments.length,o=new Array(e),u=0;u<e;u++)o[u]=arguments[u];clearTimeout(t),t=setTimeout((function(){return r.apply(void 0,o)}),n)}};export{r as debounce};
 //# sourceMappingURL=debounce.js.map

package/dist/esm/utils/helpers/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
+/* @license @siberiacancode/reactuse v0.0.13 */
 export{debounce}from"./debounce.js";export{isClient}from"./isClient.js";export{isShallowEqual}from"./isShallowEqual.js";export{throttle}from"./throttle.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/utils/helpers/isClient.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
+/* @license @siberiacancode/reactuse v0.0.13 */
 var n,d,e=!("undefined"==typeof window||null===(n=window)||void 0===n||!n.document||null===(d=window)||void 0===d||null===(d=d.document)||void 0===d||!d.createElement);export{e as isClient};
 //# sourceMappingURL=isClient.js.map

package/dist/esm/utils/helpers/isShallowEqual.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
+/* @license @siberiacancode/reactuse v0.0.13 */
 var r=function(r,e){var t=Object.keys(r),n=Object.keys(e);if(t.length!==n.length)return!1;for(var a=0,f=t;a<f.length;a++){var u=f[a];if(r[u]!==e[u])return!1}return!0};export{r as isShallowEqual};
 //# sourceMappingURL=isShallowEqual.js.map

package/dist/esm/utils/helpers/throttle.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.11 */
+/* @license @siberiacancode/reactuse v0.0.13 */
 var n=function(n,t){var o=!1;return function(){o||(n.apply(void 0,arguments),o=!0,setTimeout((function(){o=!1}),t))}};export{n as throttle};
 //# sourceMappingURL=throttle.js.map

package/dist/index.d.ts

@@ -45,12 +45,35 @@ type UseBooleanReturn = [
  */
 declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 
+/** The use click outside target element type */
 type UseClickOutsideTarget = React.RefObject<Element | null> | (() => Element) | Element;
+/** The use click outside return type */
 type UseClickOutsideReturn<Target extends UseClickOutsideTarget | UseClickOutsideTarget[]> = React.RefObject<Target>;
 type UseClickOutside = {
     <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(target: Target, callback: (event: Event) => void): void;
     <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): UseClickOutsideReturn<Target>;
 };
+/**
+ * @name useClickOutside
+ * @description - Hook to handle click events outside the specified target element(s)
+ *
+ * @overload
+ * @template Target The target element(s) to detect outside clicks for
+ * @param {Target} target The target element(s) to detect outside clicks for
+ * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
+ * @returns {void}
+ *
+ * @overload
+ * @template Target The target element(s) to detect outside clicks for
+ * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
+ * @returns {UseClickOutsideReturn<Target>} A React ref to attach to the target element
+ *
+ * @example
+ * const ref = useClickOutside<HMLDiTvElement>(() => console.log('click outside'));
+ *
+ * @example
+ * useClickOutside(ref, () => console.log('click outside'));
+ */
 declare const useClickOutside: UseClickOutside;
 
 declare const legacyCopyToClipboard: (value: string) => void;
@@ -197,6 +220,18 @@ declare function useDocumentTitle(value?: string, options?: UseDocumentTitleOpti
  */
 declare const useDocumentVisibility: () => DocumentVisibilityState;
 
+/**
+ * @name useEvent
+ * @description - Hook that creates an event and returns a stable reference of it
+ *
+ * @template Params The type of the params
+ * @template Return The type of the return
+ * @param {(...args: Params) => Return} callback The callback function
+ * @returns {(...args: Params) => Return} The callback
+ *
+ * @example
+ * const onClick = useEvent(() => console.log('clicked'));
+ */
 declare const useEvent: <Params extends unknown[], Return>(callback: (...args: Params) => Return) => ((...args: Params) => Return);
 
 type UseEventListenerTarget = React.RefObject<Element | null> | (() => Element) | Element | Window | Document;
@@ -211,25 +246,19 @@ type UseEventListener = {
 };
 declare const useEventListener: UseEventListener;
 
-/** The use favicon options */
-interface UseFaviconOptions {
-    /** The rel of the favicon */
-    rel: string;
-}
 /** The use favicon return type */
 type UseFaviconReturn = [string, React.Dispatch<React.SetStateAction<string>>];
 /**
  * @name useFavicon
  * @description - Hook that manages the favicon
  *
- * @param {string} initialFavicon The initial favicon. If not provided, the current favicon will be used
- * @param {string} [options.rel] The rel of the favicon
+ * @param {string} [initialFavicon] The initial favicon. If not provided, the current favicon will be used
  * @returns {UseFaviconReturn} An array containing the current favicon and a function to update the favicon
  *
  * @example
  * const { href, set } = useFavicon('https://www.google.com/favicon.ico');
  */
-declare const useFavicon: (initialHref?: string, options?: UseFaviconOptions) => {
+declare const useFavicon: (initialHref?: string) => {
     readonly href: string | undefined;
     readonly set: (favicon: string) => void;
 };
@@ -364,6 +393,17 @@ type UseIntersectionObserver = {
 };
 declare const useIntersectionObserver: UseIntersectionObserver;
 
+/**
+ * @name useIsFirstRender
+ * @description - Hook that returns true if the component is first render
+ *
+ * @returns {boolean} True if the component is first render
+ *
+ * @example
+ * const isFirstRender = useIsFirstRender();
+ */
+declare const useIsFirstRender: () => boolean;
+
 /**
  * @name useIsomorphicLayoutEffect
  * @description - Hook conditionally selects either `useLayoutEffect` or `useEffect` based on the environment
@@ -511,9 +551,9 @@ interface UseNetworkReturn {
 declare const getConnection: () => Connection;
 /**
  * @name useNetwork
- * @description - Hook to track network status.
+ * @description - Hook to track network status
  *
- * @returns {UseNetworkReturn} An object containing the network status.
+ * @returns {UseNetworkReturn} An object containing the network status
  *
  * @example
  * const { online, downlink, downlinkMax, effectiveType, rtt, saveData, type } = useNetwork();
@@ -562,6 +602,17 @@ interface UseOrientationReturn {
  */
 declare const useOrientation: () => UseOrientationReturn;
 
+/**
+ * @name usePageLeave
+ * @description - Hook what calls given function when mouse leaves the page
+ *
+ * @param {() => void} onPageLeave The callback function what calls then mouse leaves the page
+ *
+ * @example
+ * usePageLeave(() => console.log('on leave'))
+ */
+declare const usePageLeave: (onPageLeave: () => void) => void;
+
 /**
  * @name usePrevious
  * @description - Hook that returns the previous value
@@ -676,13 +727,13 @@ declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageI
  * @description - Hook that manages a set structure
  *
  * @template Value The type of the value
- * @param {Value[]} values The initial array of the set
+ * @param {Value[]} [values] The initial array of the set
  * @returns {Set<Value>} A set structure
  *
  * @example
  * const set = useSet([1, 2, 3]);
  */
-declare const useSet: <Value>(values: Value[]) => Set<Value>;
+declare const useSet: <Value>(values?: Value[]) => Set<Value>;
 
 /** The use step params */
 interface UseStepParams {
@@ -740,14 +791,14 @@ interface UseTimeoutReturn {
 }
 /**
  * @name useTimeout
- * @description Hook that executes a callback function after a specified delay.
+ * @description Hook that executes a callback function after a specified delay
  *
- * @param {() => void} callback The function to be executed after the timeout.
- * @param {number} delay The delay in milliseconds before the timeout executes the callback function.
- * @returns {UseTimeoutReturn} An object with a `ready` boolean state value and a `clear` function to clear timeout.
+ * @param {() => void} callback The function to be executed after the timeout
+ * @param {number} delay The delay in milliseconds before the timeout executes the callback function
+ * @returns {UseTimeoutReturn} An object with a `ready` boolean state value and a `clear` function to clear timeout
  *
  * @example
- * const { clear, ready } = useTimeout(() => {}, 5000)
+ * const { clear, ready } = useTimeout(() => {}, 5000);
  */
 declare function useTimeout(callback: () => void, delay: number): UseTimeoutReturn;
 
@@ -818,11 +869,11 @@ interface UseWindowSizeReturn {
  * @returns {UseWindowSizeReturn} An object containing the current window width and height
  *
  * @example
- * const { width, height } = useWindowSize()
+ * const { width, height } = useWindowSize();
  */
 declare const useWindowSize: (params?: UseWindowSizeParams) => {
     width: number;
     height: number;
 };
 
-export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconOptions, type UseFaviconReturn, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseOrientationReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseToggleReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, getOperatingSystem, isHotkeyMatch, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useLogger, useMediaQuery, useMount, useNetwork, useOnline, useOperatingSystem, useOrientation, usePrevious, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };
+export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconReturn, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseOrientationReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseToggleReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, getOperatingSystem, isHotkeyMatch, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useLogger, useMediaQuery, useMount, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePrevious, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -64,6 +64,7 @@
     "@siberiacancode/builder": "^1.3.0",
     "@siberiacancode/eslint": "^1.1.0",
     "@siberiacancode/prettier": "^1.1.0",
+    "@siberiacancode/vitest": "^1.2.3",
     "@testing-library/jest-dom": "^6.4.5",
     "@testing-library/react": "^15.0.7",
     "@types/doctrine": "^0.0.9",
@@ -74,7 +75,6 @@
     "doctrine": "^3.0.0",
     "eslint": "^8.56.0",
     "husky": "^9.0.11",
-    "jsdom": "^24.1.0",
     "lint-staged": "^15.2.2",
     "markdown-table": "^3.0.3",
     "react": "^18.2.0",
@@ -82,8 +82,7 @@
     "shx": "^0.3.4",
     "typescript": "^5.3.3",
     "vite": "^5.1.3",
-    "vitepress": "^1.1.4",
-    "vitest": "^1.6.0"
+    "vitepress": "^1.1.4"
   },
   "keywords": [
     "react",

package/dist/cjs/_rollupPluginBabelHelpers-OMepdpg5.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-OMepdpg5.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-TF5Io098.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-TF5Io098.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}