@siberiacancode/reactuse 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -22,7 +22,7 @@ interface UseBatteryStateReturn {
  * @returns {UseBatteryStateReturn} Object containing battery information & Battery API support
  *
  * @example
- * const battery = useBattery();
+ * const { supported, loading, charging, chargingTime, dischargingTime, level } = useBattery();
  */
 declare const useBattery: () => UseBatteryStateReturn;
 
@@ -55,12 +55,12 @@ declare const useClickOutside: UseClickOutside;
 
 declare const legacyCopyToClipboard: (value: string) => void;
 /** The use copy to clipboard return type */
-type UseCopyToClipboardReturn = [
+interface UseCopyToClipboardReturn {
     /** The copied value */
-    value: string | null,
+    value: string | null;
     /** Function to copy to clipboard  */
-    copyToClipboard: (value: string) => Promise<void>
-];
+    copy: (value: string) => Promise<void>;
+}
 /**
  * @name useCopyToClipboard
  * @description - Hook that manages a copy to clipboard
@@ -68,7 +68,7 @@ type UseCopyToClipboardReturn = [
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
  *
  * @example
- * const [copiedText, copyToClipboard] = useCopyToClipboard();
+ * const { value, copy } = useCopyToClipboard();
  */
 declare const useCopyToClipboard: () => UseCopyToClipboardReturn;
 
@@ -194,6 +194,10 @@ type UseEventListener = {
  */
 declare const useEventListener: UseEventListener;
 
+interface UseHoverOptions {
+    onEntry?: () => void;
+    onLeave?: () => void;
+}
 type UseHoverTarget = React.RefObject<Element | null> | Element;
 type UseHoverReturn<Target extends UseHoverTarget = any> = [
     React.RefObject<Target>,
@@ -201,14 +205,31 @@ type UseHoverReturn<Target extends UseHoverTarget = any> = [
 ];
 type UseHover = {
     <Target extends UseHoverTarget>(target: Target, callback?: () => void): boolean;
+    <Target extends UseHoverTarget>(target: Target, options?: UseHoverOptions): boolean;
     <Target extends UseHoverTarget>(callback?: () => void, target?: never): UseHoverReturn<Target>;
+    <Target extends UseHoverTarget>(options?: UseHoverOptions, target?: never): UseHoverReturn<Target>;
 };
 /**
  * @name useHover
- * @description - Hook that manages a counter with increment, decrement, reset, and set functionalities
+ * @description - Hook that defines the logic when hovering an element
  *
  * @example
- * const { count, dec, inc, reset, set } = useCounter(5);
+ * const hovering = useHover(ref, () => console.log('callback'));
+ *
+ * @example
+ * const [ref, hovering] = useHover(() => console.log('callback'));
+ *
+ * @example
+ * const [ref, hovering] = useHover({
+ *   onEntry: () => console.log('onEntry'),
+ *   onLeave: () => console.log('onLeave'),
+ * });
+ *
+ * @example
+ * const hovering = useHover(ref, {
+ *   onEntry: () => console.log('onEntry'),
+ *   onLeave: () => console.log('onLeave'),
+ * });
  */
 declare const useHover: UseHover;
 
@@ -326,10 +347,22 @@ declare const getConnection: () => Connection;
  * @returns {UseNetworkReturn} An object containing the network status.
  *
  * @example
- * const network = useNetwork();
+ * const { online, downlink, downlinkMax, effectiveType, rtt, saveData, type } = useNetwork();
  */
 declare const useNetwork: () => UseNetworkReturn;
 
+/**
+ * @name useNonInitialEffect
+ * @description – Hook that behaves like useEffect, but skips the effect on the initial render
+ *
+ * @param {React.EffectCallback} effect The effect callback
+ * @param {React.DependencyList} [deps] The dependencies list for the effect
+ *
+ * @example
+ * useNonInitialEffect(() => {
+ *   console.log('this effect doesn't run on the initial render');
+ * });
+ */
 declare const useNonInitialEffect: (effect: React.EffectCallback, deps?: React.DependencyList) => void;
 
 declare const useOnline: () => boolean;
@@ -352,10 +385,74 @@ declare const useRenderCount: () => number;
 
 declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
 
-declare function useTimeout(callback: () => void, delay: number): {
+/** The use step params */
+interface UseStepParams {
+    /** Initial value for step */
+    initial: number;
+    /** Maximum value for step */
+    max: number;
+}
+/** The use step return type */
+interface UseStepReturn {
+    /** Counts of steps */
+    counts: number;
+    /** Current value of step */
+    currentStep: number;
+    /** Boolean value if current step is first */
+    isFirst: boolean;
+    /** Boolean value if current step is last */
+    isLast: boolean;
+    /** Go to next step */
+    next: () => void;
+    /** Go to back step */
+    back: () => void;
+    /** Reset current step to initial value */
+    reset: () => void;
+    /** Go to custom step */
+    set: (value: number | 'last' | 'first') => void;
+}
+/**
+ * @name useStep
+ * @description - Hook that create stepper
+ *
+ * @overload
+ * @param {number} max Maximum number of steps
+ * @returns {UseStepReturn} An object contains variables and functions to change the step
+ *
+ * @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;
+
+/** The use timeout return type */
+interface UseTimeoutReturn {
+    /**  Timeout is ready state value */
     ready: boolean;
+    /** Function to clear timeout */
     clear: () => void;
-};
+}
+/**
+ * @name useTimeout
+ * @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.
+ *
+ * @example
+ * const { clear, ready } = useTimeout(() => {}, 5000)
+ */
+declare function useTimeout(callback: () => void, delay: number): UseTimeoutReturn;
+
+type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
+declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonly [Value, (value?: Value) => void];
 
 /**
  * @name useUnmount
@@ -414,4 +511,4 @@ declare const useWindowSize: (params?: UseWindowSizeParams) => {
     height: number;
 };
 
-export { type ConnectionEffectiveType, type ConnectionType, 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 UseHover, type UseHoverReturn, type UseHoverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDocumentTitle, useDocumentVisibility, useEventListener, useHover, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useMount, useNetwork, useNonInitialEffect, useOnline, useOrientation, useRenderCount, useSessionStorage, useStorage, useTimeout, useUnmount, useWindowEvent, useWindowSize };
+export { type ConnectionEffectiveType, type ConnectionType, 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 UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseToggleReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDocumentTitle, useDocumentVisibility, useEventListener, useHover, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useMount, useNetwork, useNonInitialEffect, useOnline, useOrientation, useRenderCount, useSessionStorage, useStep, useStorage, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -38,7 +38,7 @@
     "type": "tsc --noEmit",
     "pretty": "yarn type && yarn format && yarn lint",
     "prepare": "husky install",
-    "unit-test": "jest",
+    "unit-test": "vitest",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs"
@@ -62,12 +62,10 @@
   "devDependencies": {
     "@siberiacancode/builder": "^1.3.0",
     "@siberiacancode/eslint": "^1.1.0",
-    "@siberiacancode/jest": "^1.0.2",
     "@siberiacancode/prettier": "^1.1.0",
     "@testing-library/jest-dom": "^6.4.5",
     "@testing-library/react": "^15.0.7",
     "@types/doctrine": "^0.0.9",
-    "@types/jest": "^29.5.12",
     "@types/node": "^20.11.19",
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.3.0",
@@ -75,6 +73,7 @@
     "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,7 +81,8 @@
     "shx": "^0.3.4",
     "typescript": "^5.3.3",
     "vite": "^5.1.3",
-    "vitepress": "^1.1.4"
+    "vitepress": "^1.1.4",
+    "vitest": "^1.6.0"
   },
   "keywords": [
     "react",

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

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

package/dist/cjs/hooks/useToggle.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.3 */
-"use strict";var e=require("../_rollupPluginBabelHelpers-DKURZ6hh.js"),r=require("react");exports.useToggle=function(){var i=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[!1,!0],n=r.useReducer((function(e,r){var i=r instanceof Function?r(e[0]):r,n=Math.abs(e.indexOf(i));return e.slice(n).concat(e.slice(0,n))}),i),c=e._slicedToArray(n,2);return[e._slicedToArray(c[0],1)[0],c[1]]};
-//# sourceMappingURL=useToggle.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useToggle.js","sources":["../../../src/hooks/useToggle.ts"],"sourcesContent":["import React from 'react';\n\nexport type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];\n\nexport const useToggle = <Value = boolean>(values: readonly Value[] = [false, true] as any) => {\n  const [[option], toggle] = React.useReducer(\n    (state: Value[], action: React.SetStateAction<Value>) => {\n      const value = action instanceof Function ? action(state[0]) : action;\n      const index = Math.abs(state.indexOf(value));\n      return state.slice(index).concat(state.slice(0, index));\n    },\n    values as Value[]\n  );\n\n  return [option, toggle as (value?: Value) => void] as const;\n};\n"],"names":["values","arguments","length","undefined","_React$useReducer","React","useReducer","state","action","value","Function","index","Math","abs","indexOf","slice","concat","_React$useReducer2","_slicedToArray"],"mappings":";4GAIyB,WAAsE,IAApDA,EAAwBC,UAAAC,eAAAC,IAAAF,UAAA,GAAAA,UAAG,GAAA,EAAC,GAAO,GAC5EG,EAA2BC,EAAMC,YAC/B,SAACC,EAAgBC,GACf,IAAMC,EAAQD,aAAkBE,SAAWF,EAAOD,EAAM,IAAMC,EACxDG,EAAQC,KAAKC,IAAIN,EAAMO,QAAQL,IACrC,OAAOF,EAAMQ,MAAMJ,GAAOK,OAAOT,EAAMQ,MAAM,EAAGJ,GACjD,GACDX,GACDiB,EAAAC,EAAAA,eAAAd,EAAA,GAED,MAAO,CAFNc,EAAAA,eAAAD,EAAA,GAAA,GAPa,GAASA,EAAA,GAUzB"}

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

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

package/dist/esm/hooks/useToggle.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.3 */
-import{_ as r}from"../_rollupPluginBabelHelpers-CVdsimvi.js";import e from"react";var n=function(){var n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[!1,!0],t=e.useReducer((function(r,e){var n=e instanceof Function?e(r[0]):e,t=Math.abs(r.indexOf(n));return r.slice(t).concat(r.slice(0,t))}),n),o=r(t,2);return[r(o[0],1)[0],o[1]]};export{n as useToggle};
-//# sourceMappingURL=useToggle.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useToggle.js","sources":["../../../src/hooks/useToggle.ts"],"sourcesContent":["import React from 'react';\n\nexport type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];\n\nexport const useToggle = <Value = boolean>(values: readonly Value[] = [false, true] as any) => {\n  const [[option], toggle] = React.useReducer(\n    (state: Value[], action: React.SetStateAction<Value>) => {\n      const value = action instanceof Function ? action(state[0]) : action;\n      const index = Math.abs(state.indexOf(value));\n      return state.slice(index).concat(state.slice(0, index));\n    },\n    values as Value[]\n  );\n\n  return [option, toggle as (value?: Value) => void] as const;\n};\n"],"names":["useToggle","values","arguments","length","undefined","_React$useReducer","React","useReducer","state","action","value","Function","index","Math","abs","indexOf","slice","concat","_React$useReducer2","_slicedToArray"],"mappings":";sFAIaA,EAAY,WAAsE,IAApDC,EAAwBC,UAAAC,eAAAC,IAAAF,UAAA,GAAAA,UAAG,GAAA,EAAC,GAAO,GAC5EG,EAA2BC,EAAMC,YAC/B,SAACC,EAAgBC,GACf,IAAMC,EAAQD,aAAkBE,SAAWF,EAAOD,EAAM,IAAMC,EACxDG,EAAQC,KAAKC,IAAIN,EAAMO,QAAQL,IACrC,OAAOF,EAAMQ,MAAMJ,GAAOK,OAAOT,EAAMQ,MAAM,EAAGJ,GACjD,GACDX,GACDiB,EAAAC,EAAAd,EAAA,GAED,MAAO,CAFNc,EAAAD,EAAA,GAAA,GAPa,GAASA,EAAA,GAUzB"}