@siberiacancode/reactuse 0.3.9 → 0.3.12

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

@@ -7,11 +7,17 @@ export interface UseInfiniteScrollOptions {
     /** The distance in pixels to trigger the callback */
     distance?: number;
 }
+/** The use infinite scroll return type */
+export interface UseInfiniteScrollReturn {
+    /** The loading state of the infinite scroll */
+    loading: boolean;
+    /** The ref to attach to the element */
+    ref: StateRef<Element>;
+}
 export interface UseInfiniteScroll {
-    (target: HookTarget, callback: (event: Event) => void, options?: UseInfiniteScrollOptions): boolean;
-    <Target extends Element>(callback: (event: Event) => void, options?: UseInfiniteScrollOptions, target?: never): {
+    (target: HookTarget, callback: (event: Event) => void, options?: UseInfiniteScrollOptions): UseInfiniteScrollReturn;
+    <Target extends Element>(callback: (event: Event) => void, options?: UseInfiniteScrollOptions, target?: never): UseInfiniteScrollReturn & {
         ref: StateRef<Target>;
-        loading: boolean;
     };
 }
 /**
@@ -25,7 +31,7 @@ export interface UseInfiniteScroll {
  * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
  * @param {number} [options.distance=10] The distance in pixels to trigger the callback
  * @param {string} [options.direction='bottom'] The direction to trigger the callback
- * @returns {{ ref: StateRef<Target>, loading: boolean }} An object containing the ref and loading
+ * @returns {UseInfiniteScrollReturn & { ref: StateRef<Target> }} An object containing the ref and loading
  *
  * @example
  * const { ref, loading } = useInfiniteScroll(() => console.log('infinite scroll'));
@@ -35,9 +41,9 @@ export interface UseInfiniteScroll {
  * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
  * @param {number} [options.distance=10] The distance in pixels to trigger the callback
  * @param {string} [options.direction='bottom'] The direction to trigger the callback
- * @returns {boolean} A loading indicator of the infinite scroll
+ * @returns {UseInfiniteScrollReturn} An object containing the ref and loading
  *
  * @example
- * const loading = useInfiniteScroll(ref, () => console.log('infinite scroll'));
+ * const { loading } = useInfiniteScroll(ref, () => console.log('infinite scroll'));
  */
 export declare const useInfiniteScroll: UseInfiniteScroll;

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

@@ -4,10 +4,16 @@ import { StateRef } from '../useRefState/useRefState';
 export type UseKeyPressKey = string | string[];
 /** The callback function to be invoked when key is pressed */
 export type UseKeyPressCallback = (pressed: boolean, event: KeyboardEvent) => void;
+/** The use key press return type */
+export interface UseKeyPressReturn {
+    /** The pressed state of the key */
+    pressed: boolean;
+    /** The ref to attach to the element */
+    ref: StateRef<Element>;
+}
 export interface UseKeyPress {
-    (target: HookTarget | Window, key: UseKeyPressKey, callback?: UseKeyPressCallback): boolean;
-    <Target extends Element>(key: UseKeyPressKey, callback?: UseKeyPressCallback, target?: never): {
-        pressed: boolean;
+    (target: HookTarget | Window, key: UseKeyPressKey, callback?: UseKeyPressCallback): UseKeyPressReturn;
+    <Target extends Element>(key: UseKeyPressKey, callback?: UseKeyPressCallback, target?: never): UseKeyPressReturn & {
         ref: StateRef<Target>;
     };
 }
@@ -21,7 +27,7 @@ export interface UseKeyPress {
  * @param {HookTarget} [target=window] The target to attach the event listeners to
  * @param {UseKeyPressKey} key The key or keys to listen for
  * @param {(pressed: boolean, event: KeyboardEvent) => void} [callback] Callback function invoked when key is pressed
- * @returns {boolean} The pressed state of the key
+ * @returns {UseKeyPressReturn} An object containing the pressed state and ref
  *
  * @example
  * const isKeyPressed = useKeyPress(ref, 'a');

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

@@ -5,16 +5,16 @@ export interface UseKeysPressedOptions {
     /** Enable or disable the event listeners */
     enabled?: boolean;
 }
-export interface UseKeysPressed {
-    (target: HookTarget | Window, options?: UseKeysPressedOptions): Array<{
+export interface UseKeysPressedReturn {
+    /** The array of currently pressed keys */
+    value: Array<{
         key: string;
         code: string;
     }>;
-    <Target extends Element>(options?: UseKeysPressedOptions): {
-        value: Array<{
-            key: string;
-            code: string;
-        }>;
+}
+export interface UseKeysPressed {
+    (target: HookTarget | Window, options?: UseKeysPressedOptions): UseKeysPressedReturn;
+    <Target extends Element>(options?: UseKeysPressedOptions): UseKeysPressedReturn & {
         ref: StateRef<Target>;
     };
 }
@@ -27,15 +27,15 @@ export interface UseKeysPressed {
  * @overload
  * @param {HookTarget | Window} target DOM element or ref to attach keyboard listeners to
  * @param {UseKeysPressedOptions} [options.enabled=true] Enable or disable the event listeners
- * @returns {Array<{ key: string; code: string }>} Array of currently pressed keys with their key and code values
+ * @returns {UseKeysPressedReturn} Object containing the array of currently pressed keys
  *
  * @example
- * const pressedKeys = useKeysPressed(ref);
+ * const { value } = useKeysPressed(ref);
  *
  * @overload
  * @template Target - Type of the target DOM element
  * @param {UseKeysPressedOptions} [options] - Optional configuration options
- * @returns {{ keys: Array<{ key: string; code: string }>; ref: StateRef<Target> }} Object containing pressed keys array and ref to attach to a DOM element
+ * @returns {UseKeysPressedReturn & { ref: StateRef<Target> }} Object containing the array of currently pressed keys and ref to attach to the element
  *
  * @example
  * const { value, ref } = useKeysPressed();

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

@@ -7,12 +7,18 @@ export interface UseLongPressOptions {
     onFinish?: (event: LongPressEvents) => void;
     onStart?: (event: LongPressEvents) => void;
 }
+/** The use long press return type */
+export interface UseLongPressReturn {
+    /** The long pressing state */
+    pressed: boolean;
+    /** The ref to attach to the element */
+    ref: StateRef<Element>;
+}
 export interface UseLongPress {
-    (target: HookTarget, callback: (event: LongPressEvents) => void, options?: UseLongPressOptions): boolean;
+    (target: HookTarget, callback: (event: LongPressEvents) => void, options?: UseLongPressOptions): UseLongPressReturn;
     <Target extends Element>(callback: (event: LongPressEvents) => void, options?: UseLongPressOptions, target?: never): {
         ref: StateRef<Target>;
-        pressed: boolean;
-    };
+    } & UseLongPressReturn;
 }
 /**
  * @name useLongPress

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

@@ -1,3 +1,6 @@
+/** The origin of the message */
+export type UsePostMessageOrigin = string | '*' | string[];
+/** The return type of the usePostMessage hook */
 export type UsePostMessageReturn<Message> = (message: Message) => void;
 /**
  * @name usePostMessage
@@ -7,11 +10,11 @@ export type UsePostMessageReturn<Message> = (message: Message) => void;
  *
  * @overload
  * @template Message The message data type
- * @param {string | string[]} origin The origin of the message
+ * @param {UsePostMessageOrigin} origin The origin of the message
  * @param {(message: Message) => Message} callback callback to get received message
  * @returns {(message: Message) => void} An object containing the current message
  *
  * @example
  * const postMessage = usePostMessage();
  */
-export declare const usePostMessage: <Message>(origin: string | "*" | string[], callback: (message: Message, event: MessageEvent<Message>) => void) => UsePostMessageReturn<Message>;
+export declare const usePostMessage: <Message>(origin: UsePostMessageOrigin, callback: (message: Message, event: MessageEvent<Message>) => void) => UsePostMessageReturn<Message>;

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

@@ -12,10 +12,10 @@ export interface UseStickyOptions {
     root?: HookTarget;
 }
 export interface UseSticky {
-    (target: HookTarget, options?: UseStickyOptions): boolean;
-    <Target extends Element>(options?: UseStickyOptions, target?: never): {
+    (target: HookTarget, options?: UseStickyOptions): UseStickyReturn;
+    <Target extends Element>(options?: UseStickyOptions, target?: never): UseStickyReturn & {
         ref: StateRef<Target>;
-    } & UseStickyReturn;
+    };
 }
 /**
  * @name UseSticky
@@ -30,12 +30,12 @@ export interface UseSticky {
  * @returns {UseStickyReturn} The state of the sticky
  *
  * @example
- * const stuck  = useSticky(ref);
+ * const { stuck } = useSticky(ref);
  *
  * @overload
  * @param {UseStickyAxis} [options.axis='vertical'] The axis of motion of the sticky component
  * @param {UseStickyRoot} [options.root=document] The element that contains your sticky component
- * @returns {{ stickyRef: StateRef<Target> } & UseStickyReturn} The state of the sticky
+ * @returns {{ ref: StateRef<Target> } & UseStickyReturn} The state of the sticky
  *
  * @example
  * const { stuck, ref } = useSticky();

package/package.json

@@ -1,89 +1,89 @@
-{
-  "name": "@siberiacancode/reactuse",
-  "version": "0.3.9",
-  "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"
-    ]
-  }
-}
+{
+  "name": "@siberiacancode/reactuse",
+  "version": "0.3.12",
+  "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.2",
+    "@types/dom-speech-recognition": "^0.0.7",
+    "@types/react": "^19.2.13",
+    "@types/react-dom": "^19.2.3",
+    "@types/web-bluetooth": "^0.0.21",
+    "@vitejs/plugin-react": "^5.1.3",
+    "core-js": "^3.48.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "shx": "^0.4.0",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.18"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}