@siberiacancode/reactuse 0.2.24 → 0.2.26

package/package.json

@@ -1,89 +1,89 @@
-{
-  "name": "@siberiacancode/reactuse",
-  "version": "0.2.24",
-  "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.1.0",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/react": "^16.3.0",
-    "@types/dom-speech-recognition": "^0.0.6",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
-    "@types/web-bluetooth": "^0.0.21",
-    "@vitejs/plugin-react": "^4.6.0",
-    "core-js": "^3.44.0",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
-    "shx": "^0.4.0",
-    "vite": "^7.0.4",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^3.2.4"
-  },
-  "lint-staged": {
-    "*.{js,ts,tsx}": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "@siberiacancode/reactuse",
+  "version": "0.2.26",
+  "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.1.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/dom-speech-recognition": "^0.0.6",
+    "@types/react": "^19.1.9",
+    "@types/react-dom": "^19.1.7",
+    "@types/web-bluetooth": "^0.0.21",
+    "@vitejs/plugin-react": "^4.7.0",
+    "core-js": "^3.44.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
+    "shx": "^0.4.0",
+    "vite": "^7.0.6",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

package/dist/cjs/hooks/useRafValue/useRafValue.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useRafValue.cjs","sources":["../../../../src/hooks/useRafValue/useRafValue.ts"],"sourcesContent":["import { useRef, useState } from 'react';\n\nimport { useUnmount } from '../useUnmount/useUnmount';\n\n/* The use raf value params type */\nexport type UseRafValueReturn<Value> = [Value, (value: Value) => void];\n\n/**\n * @name useRafValue\n * @description - Hook that returns the value and a function to set the value\n * @category Utilities\n *\n * @template Value The type of the value\n * @param {Value} initialValue The initial value\n * @returns {UseRafValueReturn<Value>} An array containing the value and a function to set the value\n *\n * @example\n * const [value, setValue] = useRafValue(initialValue);\n */\nexport const useRafValue = <Value>(initialValue: (() => Value) | Value) => {\n  const rafIdRef = useRef(0);\n  const [value, setValue] = useState(initialValue);\n\n  const set = (value: Value) => {\n    cancelAnimationFrame(rafIdRef.current);\n    rafIdRef.current = requestAnimationFrame(() => setValue(value));\n  };\n\n  useUnmount(() => cancelAnimationFrame(rafIdRef.current));\n\n  return [value, set] as const;\n};\n"],"names":["useRafValue","initialValue","rafIdRef","useRef","value","setValue","useState","set","useUnmount"],"mappings":"mJAmBaA,EAAsBC,GAAwC,CACzE,MAAMC,EAAWC,EAAAA,OAAO,CAAC,EACnB,CAACC,EAAOC,CAAQ,EAAIC,EAAAA,SAASL,CAAY,EAEzCM,EAAOH,GAAiB,CAC5B,qBAAqBF,EAAS,OAAO,EACrCA,EAAS,QAAU,sBAAsB,IAAMG,EAASD,CAAK,CAAC,CAAA,EAGhEI,OAAAA,EAAAA,WAAW,IAAM,qBAAqBN,EAAS,OAAO,CAAC,EAEhD,CAACE,EAAOG,CAAG,CACpB"}

package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.cjs

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("react"),c=()=>{const n=typeof window<"u"&&"screen"in window&&"orientation"in window.screen,e=n?window.screen.orientation:{},[i,r]=o.useState(()=>({angle:e?.angle??0,orientationType:e?.type}));return o.useEffect(()=>{if(!n)return;const t=()=>r({angle:e.angle,orientationType:e.type});return window.addEventListener("orientationchange",t),()=>{window.removeEventListener("orientationchange",t)}}),{supported:n,value:i,lock:t=>{if(n&&typeof e.lock=="function")return e.lock(t)},unlock:()=>{n&&typeof e.unlock=="function"&&e.unlock()}}};exports.useScreenOrientation=c;
-//# sourceMappingURL=useScreenOrientation.cjs.map

package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScreenOrientation.cjs","sources":["../../../../src/hooks/useScreenOrientation/useScreenOrientation.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\ndeclare global {\n  interface ScreenOrientation {\n    lock: (orientation: OrientationLockType) => Promise<void>;\n  }\n}\n\n/* The use device orientation value type */\nexport interface UseScreenOrientationValue {\n  /** The current angle */\n  angle: number;\n  /** The current orientation type */\n  orientationType: OrientationType;\n}\n\n/* The screen lock orientation type */\nexport type OrientationLockType =\n  | 'any'\n  | 'landscape-primary'\n  | 'landscape-secondary'\n  | 'landscape'\n  | 'natural'\n  | 'portrait-primary'\n  | 'portrait-secondary'\n  | 'portrait';\n\n/* The use device orientation return type */\nexport interface useScreenOrientationReturn {\n  /** Whether the screen orientation is supported */\n  supported: boolean;\n  /** The current screen orientation value */\n  value: UseScreenOrientationValue;\n  /** Lock the screen orientation */\n  lock: (orientation: OrientationLockType) => void;\n  /** Unlock the screen orientation */\n  unlock: () => void;\n}\n\n/**\n * @name useScreenOrientation\n * @description - Hook that provides the current screen orientation\n * @category Sensors\n *\n * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation\n *\n * @returns {useScreenOrientationReturn} The current screen orientation\n *\n * @example\n * const { supported, value, lock, unlock } = useScreenOrientation();\n */\nexport const useScreenOrientation = (): useScreenOrientationReturn => {\n  const supported =\n    typeof window !== 'undefined' && 'screen' in window && 'orientation' in window.screen;\n  const screenOrientation = (supported ? window.screen.orientation : {}) as ScreenOrientation;\n\n  const [value, setValue] = useState<UseScreenOrientationValue>(() => {\n    return {\n      angle: screenOrientation?.angle ?? 0,\n      orientationType: screenOrientation?.type\n    };\n  });\n\n  useEffect(() => {\n    if (!supported) return;\n\n    const onOrientationChange = () =>\n      setValue({\n        angle: screenOrientation.angle,\n        orientationType: screenOrientation.type\n      });\n\n    window.addEventListener('orientationchange', onOrientationChange);\n    return () => {\n      window.removeEventListener('orientationchange', onOrientationChange);\n    };\n  });\n\n  const lock = (type: OrientationLockType) => {\n    if (supported && typeof screenOrientation.lock === 'function')\n      return screenOrientation.lock(type);\n  };\n\n  const unlock = () => {\n    if (supported && typeof screenOrientation.unlock === 'function') screenOrientation.unlock();\n  };\n\n  return {\n    supported,\n    value,\n    lock,\n    unlock\n  };\n};\n"],"names":["useScreenOrientation","supported","screenOrientation","value","setValue","useState","useEffect","onOrientationChange","type"],"mappings":"yGAmDaA,EAAuB,IAAkC,CACpE,MAAMC,EACJ,OAAO,OAAW,KAAe,WAAY,QAAU,gBAAiB,OAAO,OAC3EC,EAAqBD,EAAY,OAAO,OAAO,YAAc,CAAA,EAE7D,CAACE,EAAOC,CAAQ,EAAIC,EAAAA,SAAoC,KACrD,CACL,MAAOH,GAAmB,OAAS,EACnC,gBAAiBA,GAAmB,IAAA,EAEvC,EAEDI,OAAAA,EAAAA,UAAU,IAAM,CACd,GAAI,CAACL,EAAW,OAEhB,MAAMM,EAAsB,IAC1BH,EAAS,CACP,MAAOF,EAAkB,MACzB,gBAAiBA,EAAkB,IAAA,CACpC,EAEH,cAAO,iBAAiB,oBAAqBK,CAAmB,EACzD,IAAM,CACX,OAAO,oBAAoB,oBAAqBA,CAAmB,CAAA,CACrE,CACD,EAWM,CACL,UAAAN,EACA,MAAAE,EACA,KAZYK,GAA8B,CAC1C,GAAIP,GAAa,OAAOC,EAAkB,MAAS,WACjD,OAAOA,EAAkB,KAAKM,CAAI,CAAA,EAWpC,OARa,IAAM,CACfP,GAAa,OAAOC,EAAkB,QAAW,cAA8B,OAAA,CAAO,CAO1F,CAEJ"}

package/dist/esm/hooks/useRafValue/useRafValue.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useRafValue.mjs","sources":["../../../../src/hooks/useRafValue/useRafValue.ts"],"sourcesContent":["import { useRef, useState } from 'react';\n\nimport { useUnmount } from '../useUnmount/useUnmount';\n\n/* The use raf value params type */\nexport type UseRafValueReturn<Value> = [Value, (value: Value) => void];\n\n/**\n * @name useRafValue\n * @description - Hook that returns the value and a function to set the value\n * @category Utilities\n *\n * @template Value The type of the value\n * @param {Value} initialValue The initial value\n * @returns {UseRafValueReturn<Value>} An array containing the value and a function to set the value\n *\n * @example\n * const [value, setValue] = useRafValue(initialValue);\n */\nexport const useRafValue = <Value>(initialValue: (() => Value) | Value) => {\n  const rafIdRef = useRef(0);\n  const [value, setValue] = useState(initialValue);\n\n  const set = (value: Value) => {\n    cancelAnimationFrame(rafIdRef.current);\n    rafIdRef.current = requestAnimationFrame(() => setValue(value));\n  };\n\n  useUnmount(() => cancelAnimationFrame(rafIdRef.current));\n\n  return [value, set] as const;\n};\n"],"names":["useRafValue","initialValue","rafIdRef","useRef","value","setValue","useState","set","useUnmount"],"mappings":";;AAmBO,MAAMA,IAAc,CAAQC,MAAwC;AACzE,QAAMC,IAAWC,EAAO,CAAC,GACnB,CAACC,GAAOC,CAAQ,IAAIC,EAASL,CAAY,GAEzCM,IAAM,CAACH,MAAiB;AAC5B,yBAAqBF,EAAS,OAAO,GACrCA,EAAS,UAAU,sBAAsB,MAAMG,EAASD,CAAK,CAAC;AAAA,EAAA;AAGhE,SAAAI,EAAW,MAAM,qBAAqBN,EAAS,OAAO,CAAC,GAEhD,CAACE,GAAOG,CAAG;AACpB;"}

package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.mjs

@@ -1,31 +0,0 @@
-import { useState as r, useEffect as c } from "react";
-const l = () => {
-  const e = typeof window < "u" && "screen" in window && "orientation" in window.screen, n = e ? window.screen.orientation : {}, [o, i] = r(() => ({
-    angle: n?.angle ?? 0,
-    orientationType: n?.type
-  }));
-  return c(() => {
-    if (!e) return;
-    const t = () => i({
-      angle: n.angle,
-      orientationType: n.type
-    });
-    return window.addEventListener("orientationchange", t), () => {
-      window.removeEventListener("orientationchange", t);
-    };
-  }), {
-    supported: e,
-    value: o,
-    lock: (t) => {
-      if (e && typeof n.lock == "function")
-        return n.lock(t);
-    },
-    unlock: () => {
-      e && typeof n.unlock == "function" && n.unlock();
-    }
-  };
-};
-export {
-  l as useScreenOrientation
-};
-//# sourceMappingURL=useScreenOrientation.mjs.map

package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScreenOrientation.mjs","sources":["../../../../src/hooks/useScreenOrientation/useScreenOrientation.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\ndeclare global {\n  interface ScreenOrientation {\n    lock: (orientation: OrientationLockType) => Promise<void>;\n  }\n}\n\n/* The use device orientation value type */\nexport interface UseScreenOrientationValue {\n  /** The current angle */\n  angle: number;\n  /** The current orientation type */\n  orientationType: OrientationType;\n}\n\n/* The screen lock orientation type */\nexport type OrientationLockType =\n  | 'any'\n  | 'landscape-primary'\n  | 'landscape-secondary'\n  | 'landscape'\n  | 'natural'\n  | 'portrait-primary'\n  | 'portrait-secondary'\n  | 'portrait';\n\n/* The use device orientation return type */\nexport interface useScreenOrientationReturn {\n  /** Whether the screen orientation is supported */\n  supported: boolean;\n  /** The current screen orientation value */\n  value: UseScreenOrientationValue;\n  /** Lock the screen orientation */\n  lock: (orientation: OrientationLockType) => void;\n  /** Unlock the screen orientation */\n  unlock: () => void;\n}\n\n/**\n * @name useScreenOrientation\n * @description - Hook that provides the current screen orientation\n * @category Sensors\n *\n * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation\n *\n * @returns {useScreenOrientationReturn} The current screen orientation\n *\n * @example\n * const { supported, value, lock, unlock } = useScreenOrientation();\n */\nexport const useScreenOrientation = (): useScreenOrientationReturn => {\n  const supported =\n    typeof window !== 'undefined' && 'screen' in window && 'orientation' in window.screen;\n  const screenOrientation = (supported ? window.screen.orientation : {}) as ScreenOrientation;\n\n  const [value, setValue] = useState<UseScreenOrientationValue>(() => {\n    return {\n      angle: screenOrientation?.angle ?? 0,\n      orientationType: screenOrientation?.type\n    };\n  });\n\n  useEffect(() => {\n    if (!supported) return;\n\n    const onOrientationChange = () =>\n      setValue({\n        angle: screenOrientation.angle,\n        orientationType: screenOrientation.type\n      });\n\n    window.addEventListener('orientationchange', onOrientationChange);\n    return () => {\n      window.removeEventListener('orientationchange', onOrientationChange);\n    };\n  });\n\n  const lock = (type: OrientationLockType) => {\n    if (supported && typeof screenOrientation.lock === 'function')\n      return screenOrientation.lock(type);\n  };\n\n  const unlock = () => {\n    if (supported && typeof screenOrientation.unlock === 'function') screenOrientation.unlock();\n  };\n\n  return {\n    supported,\n    value,\n    lock,\n    unlock\n  };\n};\n"],"names":["useScreenOrientation","supported","screenOrientation","value","setValue","useState","useEffect","onOrientationChange","type"],"mappings":";AAmDO,MAAMA,IAAuB,MAAkC;AACpE,QAAMC,IACJ,OAAO,SAAW,OAAe,YAAY,UAAU,iBAAiB,OAAO,QAC3EC,IAAqBD,IAAY,OAAO,OAAO,cAAc,CAAA,GAE7D,CAACE,GAAOC,CAAQ,IAAIC,EAAoC,OACrD;AAAA,IACL,OAAOH,GAAmB,SAAS;AAAA,IACnC,iBAAiBA,GAAmB;AAAA,EAAA,EAEvC;AAED,SAAAI,EAAU,MAAM;AACd,QAAI,CAACL,EAAW;AAEhB,UAAMM,IAAsB,MAC1BH,EAAS;AAAA,MACP,OAAOF,EAAkB;AAAA,MACzB,iBAAiBA,EAAkB;AAAA,IAAA,CACpC;AAEH,kBAAO,iBAAiB,qBAAqBK,CAAmB,GACzD,MAAM;AACX,aAAO,oBAAoB,qBAAqBA,CAAmB;AAAA,IAAA;AAAA,EACrE,CACD,GAWM;AAAA,IACL,WAAAN;AAAA,IACA,OAAAE;AAAA,IACA,MAZW,CAACK,MAA8B;AAC1C,UAAIP,KAAa,OAAOC,EAAkB,QAAS;AACjD,eAAOA,EAAkB,KAAKM,CAAI;AAAA,IAAA;AAAA,IAWpC,QARa,MAAM;AACnB,MAAIP,KAAa,OAAOC,EAAkB,UAAW,gBAA8B,OAAA;AAAA,IAAO;AAAA,EAO1F;AAEJ;"}

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

@@ -1,35 +0,0 @@
-declare global {
-    interface ScreenOrientation {
-        lock: (orientation: OrientationLockType) => Promise<void>;
-    }
-}
-export interface UseScreenOrientationValue {
-    /** The current angle */
-    angle: number;
-    /** The current orientation type */
-    orientationType: OrientationType;
-}
-export type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
-export interface useScreenOrientationReturn {
-    /** Whether the screen orientation is supported */
-    supported: boolean;
-    /** The current screen orientation value */
-    value: UseScreenOrientationValue;
-    /** Lock the screen orientation */
-    lock: (orientation: OrientationLockType) => void;
-    /** Unlock the screen orientation */
-    unlock: () => void;
-}
-/**
- * @name useScreenOrientation
- * @description - Hook that provides the current screen orientation
- * @category Sensors
- *
- * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
- *
- * @returns {useScreenOrientationReturn} The current screen orientation
- *
- * @example
- * const { supported, value, lock, unlock } = useScreenOrientation();
- */
-export declare const useScreenOrientation: () => useScreenOrientationReturn;