@siberiacancode/reactuse 0.3.3 → 0.3.5

package/dist/esm/utils/helpers/isTarget.mjs

@@ -1,12 +1,14 @@
-const n = Symbol("target"), o = (e) => "current" in e ? e.current : typeof e.value == "function" ? e.value() : typeof e.value == "string" ? document.querySelector(e.value) : (e.value instanceof Document || e.value instanceof Window || e.value instanceof Element, e.value), l = (e) => ({
+const u = /* @__PURE__ */ Symbol("target"), o = (e) => "current" in e ? e.current : typeof e.value == "function" ? e.value() : typeof e.value == "string" ? document.querySelector(e.value) : (e.value instanceof Document || e.value instanceof Window || e.value instanceof Element, e.value), i = (e) => ({
   value: e,
-  type: n
-}), u = (e) => typeof e == "object" && ("current" in e || e && e.type === n);
-u.wrap = l;
-u.getElement = o;
+  type: u
+}), n = (e) => typeof e == "object" && ("current" in e || e && e.type === u) || typeof e == "function" && "state" in e && "current" in e, c = (e) => e && "state" in e && e.state;
+n.wrap = i;
+n.getElement = o;
+n.getRefState = c;
 export {
-  u as isTarget,
-  l as target,
-  n as targetSymbol
+  c as getRefState,
+  n as isTarget,
+  i as target,
+  u as targetSymbol
 };
 //# sourceMappingURL=isTarget.mjs.map

package/dist/esm/utils/helpers/isTarget.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"isTarget.mjs","sources":["../../../../src/utils/helpers/isTarget.ts"],"sourcesContent":["import type { RefObject } from 'react';\n\nexport const targetSymbol = Symbol('target');\n\nexport type Target = (() => Element) | string | Document | Element | Window;\n\nexport type HookTarget =\n  | RefObject<Element | null | undefined>\n  | {\n      value: Target;\n      type: symbol;\n    };\n\nconst getElement = (target: HookTarget) => {\n  if ('current' in target) {\n    return target.current;\n  }\n\n  if (typeof target.value === 'function') {\n    return target.value();\n  }\n\n  if (typeof target.value === 'string') {\n    return document.querySelector(target.value);\n  }\n\n  if (target.value instanceof Document) {\n    return target.value;\n  }\n\n  if (target.value instanceof Window) {\n    return target.value;\n  }\n\n  if (target.value instanceof Element) {\n    return target.value;\n  }\n\n  return target.value;\n};\n\nexport const target = (target: Target) => ({\n  value: target,\n  type: targetSymbol\n});\n\nexport const isTarget = (target: HookTarget) =>\n  typeof target === 'object' &&\n  ('current' in target || (target && (target as any).type === targetSymbol));\n\nisTarget.wrap = target;\nisTarget.getElement = getElement;\n"],"names":["targetSymbol","getElement","target","isTarget"],"mappings":"AAEO,MAAMA,IAAe,OAAO,QAAQ,GAWrCC,IAAa,CAACC,MACd,aAAaA,IACRA,EAAO,UAGZ,OAAOA,EAAO,SAAU,aACnBA,EAAO,MAAA,IAGZ,OAAOA,EAAO,SAAU,WACnB,SAAS,cAAcA,EAAO,KAAK,KAGxCA,EAAO,iBAAiB,YAIxBA,EAAO,iBAAiB,UAIxBA,EAAO,iBAAiB,SACnBA,EAAO,QAMLA,IAAS,CAACA,OAAoB;AAAA,EACzC,OAAOA;AAAAA,EACP,MAAMF;AACR,IAEaG,IAAW,CAACD,MACvB,OAAOA,KAAW,aACjB,aAAaA,KAAWA,KAAWA,EAAe,SAASF;AAE9DG,EAAS,OAAOD;AAChBC,EAAS,aAAaF;"}
+{"version":3,"file":"isTarget.mjs","sources":["../../../../src/utils/helpers/isTarget.ts"],"sourcesContent":["import type { RefObject } from 'react';\n\nexport const targetSymbol = Symbol('target');\n\nexport type Target = (() => Element) | string | Document | Element | Window;\ninterface StateRef<Value> {\n  (node: Value): void;\n  current: Value;\n  state: Value;\n}\n\nexport type HookTarget =\n  | RefObject<Element | null | undefined>\n  | StateRef<Element | null | undefined>\n  | {\n      value: Target;\n      type: symbol;\n    };\n\nconst getElement = (target: HookTarget) => {\n  if ('current' in target) {\n    return target.current;\n  }\n\n  if (typeof target.value === 'function') {\n    return target.value();\n  }\n\n  if (typeof target.value === 'string') {\n    return document.querySelector(target.value);\n  }\n\n  if (target.value instanceof Document) {\n    return target.value;\n  }\n\n  if (target.value instanceof Window) {\n    return target.value;\n  }\n\n  if (target.value instanceof Element) {\n    return target.value;\n  }\n\n  return target.value;\n};\n\nexport const target = (target: Target) => ({\n  value: target,\n  type: targetSymbol\n});\n\nexport const isTarget = (target: HookTarget) =>\n  (typeof target === 'object' &&\n    ('current' in target || (target && (target as any).type === targetSymbol))) ||\n  (typeof target === 'function' && 'state' in target && 'current' in target);\n\nexport const getRefState = (target?: HookTarget) => target && 'state' in target && target.state;\n\nisTarget.wrap = target;\nisTarget.getElement = getElement;\nisTarget.getRefState = getRefState;\n"],"names":["targetSymbol","getElement","target","isTarget","getRefState"],"mappings":"AAEO,MAAMA,2BAAsB,QAAQ,GAiBrCC,IAAa,CAACC,MACd,aAAaA,IACRA,EAAO,UAGZ,OAAOA,EAAO,SAAU,aACnBA,EAAO,MAAA,IAGZ,OAAOA,EAAO,SAAU,WACnB,SAAS,cAAcA,EAAO,KAAK,KAGxCA,EAAO,iBAAiB,YAIxBA,EAAO,iBAAiB,UAIxBA,EAAO,iBAAiB,SACnBA,EAAO,QAMLA,IAAS,CAACA,OAAoB;AAAA,EACzC,OAAOA;AAAAA,EACP,MAAMF;AACR,IAEaG,IAAW,CAACD,MACtB,OAAOA,KAAW,aAChB,aAAaA,KAAWA,KAAWA,EAAe,SAASF,MAC7D,OAAOE,KAAW,cAAc,WAAWA,KAAU,aAAaA,GAExDE,IAAc,CAACF,MAAwBA,KAAU,WAAWA,KAAUA,EAAO;AAE1FC,EAAS,OAAOD;AAChBC,EAAS,aAAaF;AACtBE,EAAS,cAAcC;"}

package/dist/types/hooks/useBreakpoints/useBreakpoints.d.ts

@@ -14,16 +14,6 @@ export type UseBreakpointsReturn<Breakpoint extends string = string> = {
     smallerOrEqual: (breakpoint: Breakpoint) => boolean;
     /** The function that checks if the current breakpoint is between to the given breakpoints */
     between: (a: Breakpoint, b: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is greater than to the given breakpoint */
-    isGreater: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is greater than or equal to the given breakpoint */
-    isGreaterOrEqual: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is smaller than to the given breakpoint */
-    isSmaller: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is smaller than or equal to the given breakpoint */
-    isSmallerOrEqual: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is between to the given breakpoints */
-    isInBetween: (a: Breakpoint, b: Breakpoint) => boolean;
     /** The function that returns the current breakpoints */
     current: () => Breakpoint[];
     /** The function that returns the current active breakpoint */
@@ -41,7 +31,7 @@ export type UseBreakpointsReturn<Breakpoint extends string = string> = {
  * @returns {UseBreakpointsReturn<Breakpoint>} An object containing the current breakpoint
  *
  * @example
- * const { greaterOrEqual, smallerOrEqual, current } = useBreakpoints({ mobile: 0, tablet: 640, laptop: 1024, desktop: 1280 });
+ * const { greater, smaller, between, current, active, ...breakpoints } = useBreakpoints({ mobile: 0, tablet: 640, laptop: 1024, desktop: 1280 });
  */
 export declare const useBreakpoints: <Breakpoint extends string>(breakpoints: Breakpoints<Breakpoint>, strategy?: UseBreakpointsStrategy) => UseBreakpointsReturn<Breakpoint>;
 /** Breakpoints from Material UI */

package/dist/types/hooks/useClickOutside/useClickOutside.d.ts

@@ -21,7 +21,7 @@ export interface UseClickOutside {
  * @overload
  * @template Target The target element(s)
  * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
- * @returns {(node: Target) => void} A React ref to attach to the target element
+ * @returns {StateRef<Target>} A ref to attach to the target element
  *
  * @example
  * const ref = useClickOutside<HTMLDivElement>(() => console.log('click outside'));

package/dist/types/hooks/useEventSource/useEventSource.d.ts

@@ -22,7 +22,7 @@ interface UseEventSourceReturn<Data = any> {
     instance?: EventSource;
     isConnecting: boolean;
     isError: boolean;
-    isOpen: boolean;
+    opened: boolean;
     /** Closes the EventSource connection gracefully */
     close: () => void;
     /** Reopen the EventSource connection */
@@ -42,7 +42,7 @@ interface UseEventSourceReturn<Data = any> {
  * @returns {UseEventSourceReturn<Data>} The EventSource state and controls
  *
  * @example
- * const { instance, data, isConnecting, isOpen, isError, close, open } = useEventSource('url', ['message']);
+ * const { instance, data, connecting, opened, isError, close, open } = useEventSource('url', ['message']);
  */
 export declare const useEventSource: <QueryData = any, Data = QueryData>(url: string | URL, events?: string[], options?: UseEventSourceOptions<QueryData, Data>) => UseEventSourceReturn<Data>;
 export {};

package/dist/types/hooks/useField/useField.d.ts

@@ -1,3 +1,4 @@
+import { RefObject } from 'react';
 /** The use field params type */
 export interface UseFieldParams<Value> {
     /** The auto focus */
@@ -51,6 +52,8 @@ export interface UseFieldReturn<Value> {
     dirty: boolean;
     /** The error state */
     error?: string;
+    /** The input ref */
+    ref: RefObject<HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | null>;
     /** The set error function */
     touched: boolean;
     /** The set error function */

package/dist/types/hooks/useHover/useHover.d.ts

@@ -31,7 +31,7 @@ export interface UseHover {
  * @overload
  * @param {HookTarget} target The target element to be hovered
  * @param {(event: Event) => void} [callback] The callback function to be invoked on mouse enter
- * @returns {boolean} The state of the hover
+ * @returns {boolean} The value of the hover
  *
  * @example
  * const hovering = useHover(ref, () => console.log('callback'));
@@ -40,7 +40,7 @@ export interface UseHover {
  * @param {HookTarget} target The target element to be hovered
  * @param {(event: Event) => void} [options.onEntry] The callback function to be invoked on mouse enter
  * @param {(event: Event) => void} [options.onLeave] The callback function to be invoked on mouse leave
- * @returns {boolean} The state of the hover
+ * @returns {boolean} The value of the hover
  *
  * @example
  * const hovering = useHover(ref, options);
@@ -48,18 +48,18 @@ export interface UseHover {
  * @overload
  * @template Target The target element
  * @param {(event: Event) => void} [callback] The callback function to be invoked on mouse enter
- * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The object with the ref and the value of the hover
  *
  * @example
- * const [ref, hovering] = useHover(() => console.log('callback'));
+ * const { ref, value } = useHover(() => console.log('callback'));
  *
  * @overload
  * @template Target The target element
  * @param {(event: Event) => void} [options.onEntry] The callback function to be invoked on mouse enter
  * @param {(event: Event) => void} [options.onLeave] The callback function to be invoked on mouse leave
- * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The object with the ref and the value of the hover
  *
  * @example
- * const [ref, hovering] = useHover(options);
+ * const { ref, value } = useHover(options);
  */
 export declare const useHover: UseHover;

package/dist/types/hooks/useRefState/useRefState.d.ts

@@ -3,6 +3,7 @@ export interface StateRef<Value> {
     current: Value;
     state?: Value;
 }
+export declare const createRefState: <Value>(initialValue: Value | undefined, setState: (value: Value) => void) => StateRef<Value>;
 /**
  * @name useRefState
  * @description - Hook that returns the state reference of the value

package/dist/types/hooks/useSpeechSynthesis/useSpeechSynthesis.d.ts

@@ -26,7 +26,7 @@ export interface UseSpeechSynthesisReturn {
     /** Indicates if the SpeechSynthesis API is supported in the current environment. */
     supported: boolean;
     /** The SpeechSynthesisUtterance instance. */
-    utterance: SpeechSynthesisUtterance | null;
+    utterance: SpeechSynthesisUtterance | undefined;
     /** Function to pause speech synthesis. */
     pause: () => void;
     /** Function to resume speech synthesis. */

package/dist/types/utils/helpers/isTarget.d.ts

@@ -1,7 +1,12 @@
 import { RefObject } from 'react';
 export declare const targetSymbol: unique symbol;
 export type Target = (() => Element) | string | Document | Element | Window;
-export type HookTarget = RefObject<Element | null | undefined> | {
+interface StateRef<Value> {
+    (node: Value): void;
+    current: Value;
+    state: Value;
+}
+export type HookTarget = RefObject<Element | null | undefined> | StateRef<Element | null | undefined> | {
     value: Target;
     type: symbol;
 };
@@ -16,4 +21,7 @@ export declare const isTarget: {
         type: symbol;
     };
     getElement: (target: HookTarget) => Window | Document | Element | null | undefined;
+    getRefState: (target?: HookTarget) => false | Element | null | undefined;
 };
+export declare const getRefState: (target?: HookTarget) => false | Element | null | undefined;
+export {};

package/package.json

@@ -1,89 +1,89 @@
-{
-  "name": "@siberiacancode/reactuse",
-  "version": "0.3.3",
-  "description": "The ultimate collection of react hooks",
-  "author": {
-    "name": "SIBERIA CAN CODE 🧊",
-    "url": "https://github.com/siberiacancode"
-  },
-  "license": "MIT",
-  "homepage": "https://siberiacancode.github.io/reactuse/",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/siberiacancode/reactuse.git",
-    "directory": "packages/core"
-  },
-  "bugs": "https://github.com/siberiacancode/reactuse/issues",
-  "keywords": [
-    "react",
-    "react hooks",
-    "react use",
-    "use",
-    "hooks"
-  ],
-  "sideEffects": false,
-  "exports": {
-    "types": "./dist/types/index.d.ts",
-    "import": "./dist/esm/index.mjs",
-    "require": "./dist/cjs/index.cjs"
-  },
-  "main": "dist/cjs/index.cjs",
-  "module": "dist/esm/index.mjs",
-  "types": "dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=14"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "prepublishOnly": "pnpm unit-test run && pnpm build",
-    "build": "shx rm -rf dist && vite build",
-    "build:js": "tsc --project tsconfig.build.json && prettier --write src/bundle",
-    "lint": "eslint . --fix",
-    "lint-inspector": "npx @eslint/config-inspector@latest",
-    "format": "prettier --write .",
-    "pretty": "pnpm lint && pnpm format",
-    "unit-test": "vitest",
-    "lint-staged": "lint-staged"
-  },
-  "peerDependencies": {
-    "@types/react": "^18 || ^19",
-    "react": "^18 || ^19",
-    "react-dom": "^18 || ^19"
-  },
-  "peerDependenciesMeta": {
-    "@types/react": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "screenfull": "^6.0.2"
-  },
-  "devDependencies": {
-    "@siberiacancode/vitest": "^2.2.0",
-    "@testing-library/dom": "^10.4.1",
-    "@testing-library/react": "^16.3.0",
-    "@types/dom-speech-recognition": "^0.0.7",
-    "@types/react": "^19.2.2",
-    "@types/react-dom": "^19.2.2",
-    "@types/web-bluetooth": "^0.0.21",
-    "@vitejs/plugin-react": "^5.1.0",
-    "core-js": "^3.46.0",
-    "react": "^19.2.0",
-    "react-dom": "^19.2.0",
-    "shx": "^0.4.0",
-    "vite": "^7.2.2",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^4.0.8"
-  },
-  "lint-staged": {
-    "*.{js,ts,tsx}": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "@siberiacancode/reactuse",
+  "version": "0.3.5",
+  "description": "The ultimate collection of react hooks",
+  "author": {
+    "name": "SIBERIA CAN CODE 🧊",
+    "url": "https://github.com/siberiacancode"
+  },
+  "license": "MIT",
+  "homepage": "https://siberiacancode.github.io/reactuse/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/siberiacancode/reactuse.git",
+    "directory": "packages/core"
+  },
+  "bugs": "https://github.com/siberiacancode/reactuse/issues",
+  "keywords": [
+    "react",
+    "react hooks",
+    "react use",
+    "use",
+    "hooks"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "types": "./dist/types/index.d.ts",
+    "import": "./dist/esm/index.mjs",
+    "require": "./dist/cjs/index.cjs"
+  },
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "pnpm unit-test run && pnpm build",
+    "build": "shx rm -rf dist && vite build",
+    "build:js": "tsc --project tsconfig.build.json && prettier --write src/bundle",
+    "lint": "eslint . --fix",
+    "lint-inspector": "npx @eslint/config-inspector@latest",
+    "format": "prettier --write .",
+    "pretty": "pnpm lint && pnpm format",
+    "unit-test": "vitest",
+    "lint-staged": "lint-staged"
+  },
+  "peerDependencies": {
+    "@types/react": "^18 || ^19",
+    "react": "^18 || ^19",
+    "react-dom": "^18 || ^19"
+  },
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "screenfull": "^6.0.2"
+  },
+  "devDependencies": {
+    "@siberiacancode/vitest": "^2.3.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.1",
+    "@types/dom-speech-recognition": "^0.0.7",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@types/web-bluetooth": "^0.0.21",
+    "@vitejs/plugin-react": "^5.1.2",
+    "core-js": "^3.47.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "shx": "^0.4.0",
+    "vite": "^7.3.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.16"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}