@siberiacancode/reactuse 0.0.15 → 0.0.17

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.15 */
-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{usePreferredLanguages}from"./hooks/usePreferredLanguages/usePreferredLanguages.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-CGXK2lQo.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-BXm8JW5o.js";
+/* @license @siberiacancode/reactuse v0.0.17 */
+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{usePreferredLanguages}from"./hooks/usePreferredLanguages/usePreferredLanguages.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-BzIoFaF6.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-DCpdzFtI.js";
 //# sourceMappingURL=index.js.map

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

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.15 */
+/* @license @siberiacancode/reactuse v0.0.17 */
 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.15 */
+/* @license @siberiacancode/reactuse v0.0.17 */
 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.15 */
+/* @license @siberiacancode/reactuse v0.0.17 */
 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.15 */
+/* @license @siberiacancode/reactuse v0.0.17 */
 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.15 */
+/* @license @siberiacancode/reactuse v0.0.17 */
 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

@@ -58,21 +58,22 @@ type 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
+ * @template Target The target element(s)
  * @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}
  *
+ * @example
+ * useClickOutside(ref, () => console.log('click outside'));
+ *
  * @overload
- * @template Target The target element(s) to detect outside clicks for
+ * @template Target The target element(s)
  * @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;
 
@@ -136,15 +137,16 @@ type UseCounter = {
  * @param {number} [options.min=Number.NEGATIVE_INFINITY] The min of count value
  * @param {number} [options.max=Number.POSITIVE_INFINITY] The max of count value
  * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter
-
+ *
+ * @example
+ * const { count, dec, inc, reset, set } = useCounter(5);
+ *
  * @overload
  * @param {number} [params.initialValue=0] The initial number value
  * @param {number} [params.min=Number.NEGATIVE_INFINITY] The min of count value
  * @param {number} [params.max=Number.POSITIVE_INFINITY] The max of count value
  * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter
  *
- * @example
- * const { count, dec, inc, reset, set } = useCounter(5);
  *
  * @example
  * const { count, dec, inc, reset, set } = useCounter({ initialValue: 5, min: 0, max: 10 });
@@ -333,20 +335,44 @@ type UseHover = {
  * @name useHover
  * @description - Hook that defines the logic when hovering an element
  *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to be hovered
+ * @param {() => void} [callback] The callback function to be invoked on mouse enter
+ * @returns {boolean} The state of the hover
+ *
  * @example
  * const hovering = useHover(ref, () => console.log('callback'));
  *
- * @example
- * const [ref, hovering] = useHover(() => console.log('callback'));
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to be hovered
+ * @param {() => void} [options.onEntry] The callback function to be invoked on mouse enter
+ * @param {() => void} [options.onLeave] The callback function to be invoked on mouse leave
+ * @returns {boolean} The state of the hover
  *
  * @example
- * const [ref, hovering] = useHover({
+ * const hovering = useHover(ref, {
  *   onEntry: () => console.log('onEntry'),
  *   onLeave: () => console.log('onLeave'),
  * });
  *
+ * @overload
+ * @template Target The target element
+ * @param {() => void} [callback] The callback function to be invoked on mouse enter
+ * @returns {UseHoverReturn<Target>} The state of the hover
+ *
  * @example
- * const hovering = useHover(ref, {
+ * const [ref, hovering] = useHover(() => console.log('callback'));
+ *
+ * @overload
+ * @template Target The target element
+ * @param {() => void} [options.onEntry] The callback function to be invoked on mouse enter
+ * @param {() => void} [options.onLeave] The callback function to be invoked on mouse leave
+ * @returns {UseHoverReturn<Target>} The state of the hover
+ *
+ * @example
+ * const [ref, hovering] = useHover({
  *   onEntry: () => console.log('onEntry'),
  *   onLeave: () => console.log('onLeave'),
  * });
@@ -354,8 +380,8 @@ type UseHover = {
 declare const useHover: UseHover;
 
 interface UseIdleOptions {
-    initialState?: boolean;
-    events?: Array<keyof WindowEventMap>;
+    initialValue?: boolean;
+    events?: Array<keyof DocumentEventMap>;
 }
 interface UseIdleReturn {
     idle: boolean;
@@ -373,7 +399,7 @@ interface UseIdleReturn {
  * @example
  * const { idle, lastActive } = useIdle();
  */
-declare const useIdle: (milliseconds?: number, { initialState, events }?: UseIdleOptions) => UseIdleReturn;
+declare const useIdle: (milliseconds?: number, { initialValue, events }?: UseIdleOptions) => UseIdleReturn;
 
 type UseIntersectionObserverTarget = React.RefObject<Element | null> | (() => Element) | Element;
 interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
@@ -780,15 +806,15 @@ interface UseStepReturn {
  * @param {number} max Maximum number of steps
  * @returns {UseStepReturn} An object contains variables and functions to change the step
  *
+ * @example
+ * const step = useStep(5);
+ *
  * @overload
  * @param {number} params.max Maximum number of steps
  * @param {number} params.initial Initial value for step
  * @returns {UseStepReturn} An object contains variables and functions to change the step
  *
  * @example
- * const step = useStep(5);
- *
- * @example
  * const stepper = useStep({ initial: 2, max: 5 });
  */
 declare const useStep: (params: number | UseStepParams) => UseStepReturn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -90,5 +90,8 @@
     "react use",
     "use",
     "hooks"
-  ]
+  ],
+  "dependencies": {
+    "screenfull": "^6.0.2"
+  }
 }

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

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

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

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