@siberiacancode/reactuse 0.0.44 → 0.0.45

package/dist/index.d.ts

@@ -68,11 +68,9 @@ declare const useBrowserLanguage: () => string;
 
 /** The use click outside target element type */
 type UseClickOutsideTarget = RefObject<Element | null> | (() => Element) | Element;
-/** The use click outside return type */
-type UseClickOutsideReturn<Target extends UseClickOutsideTarget | UseClickOutsideTarget[]> = 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>;
+    <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): RefObject<Target>;
 };
 /**
  * @name useClickOutside
@@ -104,18 +102,20 @@ interface UseCopyToClipboardReturn {
     value: string | null;
     /** Function to copy to clipboard  */
     copy: (value: string) => Promise<void>;
+    /** Whether the copy to clipboard is supported */
+    supported: boolean;
 }
 /**
- * @name useCopyToClipboard
+ * @name useClipboard
  * @description - Hook that manages a copy to clipboard
  * @category Browser
  *
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
  *
  * @example
- * const { value, copy } = useCopyToClipboard();
+ * const { supported, value, copy } = useClipboard();
  */
-declare const useCopyToClipboard: () => UseCopyToClipboardReturn;
+declare const useClipboard: () => UseCopyToClipboardReturn;
 
 /** The use counter options */
 interface UseCounterOptions {
@@ -124,14 +124,6 @@ interface UseCounterOptions {
     /** The max of count value */
     max?: number;
 }
-interface UseCounterParams {
-    /** The initial number value, defaults to 0 */
-    initialValue?: number;
-    /** The min of count value */
-    min?: number;
-    /** The max of count value */
-    max?: number;
-}
 /** The use counter return type */
 interface UseCounterReturn {
     /** The current count value */
@@ -147,7 +139,9 @@ interface UseCounterReturn {
 }
 type UseCounter = {
     (initialValue?: number, options?: UseCounterOptions): UseCounterReturn;
-    ({ initialValue, max, min }: UseCounterParams, options?: never): UseCounterReturn;
+    (options: UseCounterOptions & {
+        initialValue?: number;
+    }, initialValue?: never): UseCounterReturn;
 };
 /**
  * @name useCounter
@@ -839,12 +833,15 @@ interface UseImageOptions {
  */
 declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, 'select' | 'initialData' | 'placeholderData'>) => UseQueryReturn<HTMLImageElement>;
 
+/** The intersection observer target element type */
 type UseIntersectionObserverTarget = RefObject<Element | null> | (() => Element) | Element;
+/** The intersection observer options type */
 interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
     enabled?: boolean;
     onChange?: (entry: IntersectionObserverEntry) => void;
     root?: IntersectionObserverInit['root'] | RefObject<Element | null>;
 }
+/** The intersection observer return type */
 interface UseIntersectionObserverReturn {
     inView: boolean;
     entry?: IntersectionObserverEntry;
@@ -855,6 +852,32 @@ type UseIntersectionObserver = {
         ref: RefObject<Target>;
     };
 };
+/**
+ * @name useIntersectionObserver
+ * @description - Hook that gives you intersection observer state
+ * @category Browser
+ *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to detect intersection
+ * @param {boolean} [options.enabled=true] The IntersectionObserver options
+ * @param {((entries: IntersectionObserverEntry[], observer: IntersectionObserver) => void) | undefined} [options.onChange] The callback to execute when intersection is detected
+ * @param {IntersectionObserverInit['root'] | RefObject<Element | null>} [options.root] The root element to observe
+ * @returns {UseIntersectionObserverReturn} An object containing the state and the supported status
+ *
+ * @example
+ * const { ref, entry, inView } = useIntersectionObserver();
+ *
+ * @overload
+ * @template Target The target element
+ * @param {boolean} [options.enabled=true] The IntersectionObserver options
+ * @param {((entries: IntersectionObserverEntry[], observer: IntersectionObserver) => void) | undefined} [options.onChange] The callback to execute when intersection is detected
+ * @param {IntersectionObserverInit['root'] | RefObject<Element | null>} [options.root] The root element to observe
+ * @returns {UseIntersectionObserverReturn & { ref: RefObject<Target> }} A React ref to attach to the target element
+ *
+ * @example
+ * const { entry, inView } = useIntersectionObserver(ref);
+ */
 declare const useIntersectionObserver: UseIntersectionObserver;
 
 /** The use interval options */
@@ -1629,6 +1652,51 @@ interface UseRerenderReturns {
  */
 declare const useRerender: () => UseRerenderReturns;
 
+/** The resize observer target element type */
+type UseResizeObserverTarget = RefObject<Element | null> | (() => Element) | Element;
+/** The resize observer options type */
+interface UseResizeObserverOptions extends ResizeObserverOptions {
+    enabled?: boolean;
+    onChange?: (entries: ResizeObserverEntry[], observer: ResizeObserver) => void;
+}
+/** The resize observer return type */
+interface UseResizeObserverReturn {
+    entries: ResizeObserverEntry[];
+}
+type UseResizeObserver = {
+    <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(target: Target, options?: UseResizeObserverOptions): UseResizeObserverReturn;
+    <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
+        ref: RefObject<Target>;
+    };
+};
+/**
+ *  @name useResizeObserver
+ *  @description - Hook that gives you resize observer state
+ *  @category Browser
+ *
+ *  @overload
+ *  @template Target The target element
+ *  @param {boolean} [options.enabled=true] The IntersectionObserver options
+ *  @param {boolean} [options.box] The IntersectionObserver options
+ *  @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
+ *  @returns {UseResizeObserverReturn} An object containing the resize observer state
+ *
+ *  @example
+ *  const { ref, entries } = useResizeObserver();
+ *
+ *  @overload
+ *  @template Target The target element
+ *  @param {Target} target The target element to observe
+ *  @param {boolean} [options.enabled=true] The IntersectionObserver options
+ *  @param {boolean} [options.box] The IntersectionObserver options
+ *  @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
+ *  @returns {UseResizeObserverReturn} An object containing the resize observer state
+ *
+ *  @example
+ *  const { entries } = useResizeObserver(ref);
+ */
+declare const useResizeObserver: UseResizeObserver;
+
 /** The use script status */
 type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
 /** The use script options extends from attributes script tag */
@@ -2060,6 +2128,8 @@ declare const getRetry: (retry: number | boolean) => number;
 
 declare const isClient: boolean;
 
+declare const isPermissionAllowed: (status: PermissionState) => boolean;
+
 declare const throttle: <Params extends any[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
 declare const getDate: (now?: Date) => {
@@ -2076,4 +2146,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useCopyToClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };
+export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.44",
+  "version": "0.0.45",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

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

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

package/dist/cjs/hooks/useCopyToClipboard/useCopyToClipboard.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.44 */
-"use strict";var e=require("../../_rollupPluginBabelHelpers-Bx9oEugz.js"),r=require("react"),t=function(e){var r=document.createElement("textarea");r.value=e,document.body.appendChild(r),r.select(),document.execCommand("copy"),document.body.removeChild(r)};exports.legacyCopyToClipboard=t,exports.useCopyToClipboard=function(){var n=r.useState(null),a=e._slicedToArray(n,2),o=a[0],c=a[1],u=r.useCallback(function(){var r=e._asyncToGenerator(e._regeneratorRuntime().mark((function r(n){var a;return e._regeneratorRuntime().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(e.prev=0,null===(a=navigator)||void 0===a||null===(a=a.clipboard)||void 0===a||!a.writeText){e.next=7;break}return e.next=4,navigator.clipboard.writeText(n);case 4:c(n),e.next=8;break;case 7:throw new Error("writeText not supported");case 8:e.next=14;break;case 10:e.prev=10,e.t0=e.catch(0),t(n),c(n);case 14:case"end":return e.stop()}}),r,null,[[0,10]])})));return function(e){return r.apply(this,arguments)}}(),[]);return{value:o,copy:u}};
-//# sourceMappingURL=useCopyToClipboard.js.map

package/dist/cjs/hooks/useCopyToClipboard/useCopyToClipboard.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useCopyToClipboard.js","sources":["../../../../src/hooks/useCopyToClipboard/useCopyToClipboard.ts"],"sourcesContent":["import { useCallback, useState } from 'react';\n\nexport const legacyCopyToClipboard = (value: string) => {\n  const tempTextArea = document.createElement('textarea');\n  tempTextArea.value = value;\n  document.body.appendChild(tempTextArea);\n  tempTextArea.select();\n  document.execCommand('copy');\n  document.body.removeChild(tempTextArea);\n};\n\n/** The use copy to clipboard return type */\ninterface UseCopyToClipboardReturn {\n  /** The copied value */\n  value: string | null;\n  /** Function to copy to clipboard  */\n  copy: (value: string) => Promise<void>;\n}\n\n/**\n * @name useCopyToClipboard\n * @description - Hook that manages a copy to clipboard\n * @category Browser\n *\n * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state\n *\n * @example\n * const { value, copy } = useCopyToClipboard();\n */\nexport const useCopyToClipboard = (): UseCopyToClipboardReturn => {\n  const [value, setValue] = useState<string | null>(null);\n\n  const copyToClipboard = useCallback(async (value: string) => {\n    try {\n      if (navigator?.clipboard?.writeText) {\n        await navigator.clipboard.writeText(value);\n        setValue(value);\n      } else {\n        throw new Error('writeText not supported');\n      }\n    } catch (error) {\n      legacyCopyToClipboard(value);\n      setValue(value);\n    }\n  }, []);\n\n  return { value, copy: copyToClipboard };\n};\n"],"names":["legacyCopyToClipboard","value","tempTextArea","document","createElement","body","appendChild","select","execCommand","removeChild","_useState","useState","_useState2","_slicedToArray","setValue","copyToClipboard","useCallback","_ref","_asyncToGenerator","_regeneratorRuntime","mark","_callee","_navigator","wrap","_context","prev","next","navigator","clipboard","writeText","Error","t0","stop","_x","apply","this","arguments","copy"],"mappings":";6FAEaA,EAAwB,SAACC,GACpC,IAAMC,EAAeC,SAASC,cAAc,YAC5CF,EAAaD,MAAQA,EACrBE,SAASE,KAAKC,YAAYJ,GAC1BA,EAAaK,SACbJ,SAASK,YAAY,QACrBL,SAASE,KAAKI,YAAYP,EAC5B,6DAoBkC,WAChC,IAAAQ,EAA0BC,EAAQA,SAAgB,MAAKC,EAAAC,EAAAA,eAAAH,EAAA,GAAhDT,EAAKW,EAAA,GAAEE,EAAQF,EAAA,GAEhBG,EAAkBC,EAAAA,YAAW,WAAA,IAAAC,EAAAC,EAAAA,kBAAAC,EAAAA,sBAAAC,MAAC,SAAAC,EAAOpB,GAAa,IAAAqB,EAAA,OAAAH,EAAAA,sBAAAI,MAAA,SAAAC,GAAA,cAAAA,EAAAC,KAAAD,EAAAE,MAAA,KAAA,EAAA,GAAAF,EAAAC,KAAA,EAEvCH,QAFuCA,EAEhDK,qBAASL,GAAWA,QAAXA,EAATA,EAAWM,iBAAXN,IAAoBA,IAApBA,EAAsBO,UAAS,CAAAL,EAAAE,KAAA,EAAA,KAAA,CAAA,OAAAF,EAAAE,KAAA,EAC3BC,UAAUC,UAAUC,UAAU5B,GAAM,KAAA,EAC1Ca,EAASb,GAAOuB,EAAAE,KAAA,EAAA,MAAA,KAAA,EAAA,MAEV,IAAII,MAAM,2BAA0B,KAAA,EAAAN,EAAAE,KAAA,GAAA,MAAA,KAAA,GAAAF,EAAAC,KAAA,GAAAD,EAAAO,GAAAP,EAAA,MAAA,GAG5CxB,EAAsBC,GACtBa,EAASb,GAAO,KAAA,GAAA,IAAA,MAAA,OAAAuB,EAAAQ,OAAA,GAAAX,EAAA,KAAA,CAAA,CAAA,EAAA,KAEnB,KAAA,OAAA,SAAAY,GAAA,OAAAhB,EAAAiB,MAAAC,KAAAC,UAAA,CAAA,CAZkC,GAYhC,IAEH,MAAO,CAAEnC,MAAAA,EAAOoC,KAAMtB,EACxB"}

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

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

package/dist/esm/hooks/useCopyToClipboard/useCopyToClipboard.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.44 */
-import{_ as e,d as r,e as t}from"../../_rollupPluginBabelHelpers-CePHKKZk.js";import{useState as n,useCallback as a}from"react";var o=function(e){var r=document.createElement("textarea");r.value=e,document.body.appendChild(r),r.select(),document.execCommand("copy"),document.body.removeChild(r)},c=function(){var c=n(null),u=e(c,2),i=u[0],l=u[1],p=a(function(){var e=r(t().mark((function e(r){var n;return t().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(e.prev=0,null===(n=navigator)||void 0===n||null===(n=n.clipboard)||void 0===n||!n.writeText){e.next=7;break}return e.next=4,navigator.clipboard.writeText(r);case 4:l(r),e.next=8;break;case 7:throw new Error("writeText not supported");case 8:e.next=14;break;case 10:e.prev=10,e.t0=e.catch(0),o(r),l(r);case 14:case"end":return e.stop()}}),e,null,[[0,10]])})));return function(r){return e.apply(this,arguments)}}(),[]);return{value:i,copy:p}};export{o as legacyCopyToClipboard,c as useCopyToClipboard};
-//# sourceMappingURL=useCopyToClipboard.js.map

package/dist/esm/hooks/useCopyToClipboard/useCopyToClipboard.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useCopyToClipboard.js","sources":["../../../../src/hooks/useCopyToClipboard/useCopyToClipboard.ts"],"sourcesContent":["import { useCallback, useState } from 'react';\n\nexport const legacyCopyToClipboard = (value: string) => {\n  const tempTextArea = document.createElement('textarea');\n  tempTextArea.value = value;\n  document.body.appendChild(tempTextArea);\n  tempTextArea.select();\n  document.execCommand('copy');\n  document.body.removeChild(tempTextArea);\n};\n\n/** The use copy to clipboard return type */\ninterface UseCopyToClipboardReturn {\n  /** The copied value */\n  value: string | null;\n  /** Function to copy to clipboard  */\n  copy: (value: string) => Promise<void>;\n}\n\n/**\n * @name useCopyToClipboard\n * @description - Hook that manages a copy to clipboard\n * @category Browser\n *\n * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state\n *\n * @example\n * const { value, copy } = useCopyToClipboard();\n */\nexport const useCopyToClipboard = (): UseCopyToClipboardReturn => {\n  const [value, setValue] = useState<string | null>(null);\n\n  const copyToClipboard = useCallback(async (value: string) => {\n    try {\n      if (navigator?.clipboard?.writeText) {\n        await navigator.clipboard.writeText(value);\n        setValue(value);\n      } else {\n        throw new Error('writeText not supported');\n      }\n    } catch (error) {\n      legacyCopyToClipboard(value);\n      setValue(value);\n    }\n  }, []);\n\n  return { value, copy: copyToClipboard };\n};\n"],"names":["legacyCopyToClipboard","value","tempTextArea","document","createElement","body","appendChild","select","execCommand","removeChild","useCopyToClipboard","_useState","useState","_useState2","_slicedToArray","setValue","copyToClipboard","useCallback","_ref","_asyncToGenerator","_regeneratorRuntime","mark","_callee","_navigator","wrap","_context","prev","next","navigator","clipboard","writeText","Error","t0","stop","_x","apply","this","arguments","copy"],"mappings":";oIAEaA,EAAwB,SAACC,GACpC,IAAMC,EAAeC,SAASC,cAAc,YAC5CF,EAAaD,MAAQA,EACrBE,SAASE,KAAKC,YAAYJ,GAC1BA,EAAaK,SACbJ,SAASK,YAAY,QACrBL,SAASE,KAAKI,YAAYP,EAC5B,EAoBaQ,EAAqB,WAChC,IAAAC,EAA0BC,EAAwB,MAAKC,EAAAC,EAAAH,EAAA,GAAhDV,EAAKY,EAAA,GAAEE,EAAQF,EAAA,GAEhBG,EAAkBC,EAAW,WAAA,IAAAC,EAAAC,EAAAC,IAAAC,MAAC,SAAAC,EAAOrB,GAAa,IAAAsB,EAAA,OAAAH,IAAAI,MAAA,SAAAC,GAAA,cAAAA,EAAAC,KAAAD,EAAAE,MAAA,KAAA,EAAA,GAAAF,EAAAC,KAAA,EAEvCH,QAFuCA,EAEhDK,qBAASL,GAAWA,QAAXA,EAATA,EAAWM,iBAAXN,IAAoBA,IAApBA,EAAsBO,UAAS,CAAAL,EAAAE,KAAA,EAAA,KAAA,CAAA,OAAAF,EAAAE,KAAA,EAC3BC,UAAUC,UAAUC,UAAU7B,GAAM,KAAA,EAC1Cc,EAASd,GAAOwB,EAAAE,KAAA,EAAA,MAAA,KAAA,EAAA,MAEV,IAAII,MAAM,2BAA0B,KAAA,EAAAN,EAAAE,KAAA,GAAA,MAAA,KAAA,GAAAF,EAAAC,KAAA,GAAAD,EAAAO,GAAAP,EAAA,MAAA,GAG5CzB,EAAsBC,GACtBc,EAASd,GAAO,KAAA,GAAA,IAAA,MAAA,OAAAwB,EAAAQ,OAAA,GAAAX,EAAA,KAAA,CAAA,CAAA,EAAA,KAEnB,KAAA,OAAA,SAAAY,GAAA,OAAAhB,EAAAiB,MAAAC,KAAAC,UAAA,CAAA,CAZkC,GAYhC,IAEH,MAAO,CAAEpC,MAAAA,EAAOqC,KAAMtB,EACxB"}