@siberiacancode/reactuse 0.3.12 → 0.3.14

package/dist/types/helpers/index.d.ts

@@ -1,4 +1,6 @@
 export * from './createContext/createContext';
+export * from './createContextHook/createContextHook';
 export * from './createEventEmitter/createEventEmitter';
 export * from './createReactiveContext/createReactiveContext';
+export * from './createSharedHook/createSharedHook';
 export * from './createStore/createStore';

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

@@ -1,4 +1,5 @@
 export * from './useInterval/useInterval';
+export * from './useProgress/useProgress';
 export * from './useStopwatch/useStopwatch';
 export * from './useTime/useTime';
 export * from './useTimeout/useTimeout';

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

@@ -1,12 +1,10 @@
 import { RefObject } from 'react';
 /** The use field params type */
-export interface UseFieldParams<Value> {
+export interface UseFieldOptions {
     /** The auto focus */
     autoFocus?: boolean;
     /** The initial touched */
     initialTouched?: boolean;
-    /** The initial value */
-    initialValue?: Value;
     /** The validate on blur */
     validateOnBlur?: boolean;
     /** The validate on mount */
@@ -16,10 +14,6 @@ export interface UseFieldParams<Value> {
 }
 /** The use field register params type */
 export interface UseFieldRegisterParams {
-    /** The required validation */
-    required?: string;
-    /** The custom validation */
-    validate?: (value: string) => Promise<string | true>;
     /** The min value validation */
     max?: {
         value: number;
@@ -45,6 +39,10 @@ export interface UseFieldRegisterParams {
         value: RegExp;
         message: string;
     };
+    /** The required validation */
+    required?: string;
+    /** The custom validation */
+    validate?: (value: string) => Promise<string | true>;
 }
 /** The use field return type */
 export interface UseFieldReturn<Value> {
@@ -96,4 +94,4 @@ export interface UseFieldReturn<Value> {
  * @example
  * const { register, getValue, setValue, reset, dirty, error, setError, clearError, touched, focus, watch } = useField();
  */
-export declare const useField: <Value extends boolean | number | string = string, Type = Value extends string ? string : Value extends boolean ? boolean : number>(params?: UseFieldParams<Value>) => UseFieldReturn<Type>;
+export declare const useField: <Value extends boolean | number | string = string, Type = Value extends string ? string : Value extends boolean ? boolean : number>(initialValue?: Value, options?: UseFieldOptions) => UseFieldReturn<Type>;

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

@@ -2,6 +2,13 @@ import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
 /** The use mouse return type */
 export interface UseMouseReturn {
+    /** The latest mouse value snapshot */
+    snapshot: UseMouseValue;
+    /** Function to enable subscriptions and rerender on next updates */
+    watch: () => UseMouseValue;
+}
+/** The use mouse value type */
+export interface UseMouseValue {
     /** The current mouse client x position */
     clientX: number;
     /** The current mouse client y position */
@@ -19,12 +26,13 @@ export interface UseMouseReturn {
     /** The current mouse y position */
     y: number;
 }
+export type UseMouseCallback = (value: UseMouseValue, event: Event) => void;
 export interface UseMouse {
-    (target: HookTarget): UseMouseReturn;
-    <Target extends Element>(target?: never): UseMouseReturn & {
+    (target: HookTarget, callback?: UseMouseCallback): UseMouseReturn;
+    <Target extends Element>(callback?: UseMouseCallback, target?: never): UseMouseReturn & {
         ref: StateRef<Target>;
     };
-    (target?: Window): UseMouseReturn;
+    (target?: Window, callback?: UseMouseCallback): UseMouseReturn;
 }
 /**
  * @name useMouse
@@ -34,16 +42,18 @@ export interface UseMouse {
  *
  * @overload
  * @param {HookTarget} [target=window] The target element to manage the mouse position for
- * @returns {UseMouseReturn} An object with the current mouse position
+ * @param {(value: UseMouseValue, event: Event) => void} [callback] The callback to invoke on mouse updates
+ * @returns {UseMouseReturn} An object with mouse value controls
  *
  * @example
- * const { x, y, clientX, clientY, elementX, elementY, elementPositionX, elementPositionY } = useMouse(ref);
+ * const mouse = useMouse(ref);
  *
  * @overload
  * @template Target The target element
- * @returns {UseMouseReturn & { ref: StateRef<Target> }} An object with the current mouse position and a ref
+ * @param {(value: UseMouseValue, event: Event) => void} [callback] The callback to invoke on mouse updates
+ * @returns {UseMouseReturn & { ref: StateRef<Target> }} An object with mouse value controls and a ref
  *
  * @example
- * const { ref, x, y, clientX, clientY, elementX, elementY, elementPositionX, elementPositionY } = useMouse();
+ * const mouse = useMouse<HTMLDivElement>();
  */
 export declare const useMouse: UseMouse;

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

@@ -0,0 +1,53 @@
+/** The use progress options type */
+export interface UseProgressOptions {
+    /** Delay before reset to null after done */
+    delay?: number;
+    /** Start progress immediately */
+    immediately?: boolean;
+    /** Maximum progress value */
+    maximum?: number;
+    /** Additional random amount for each auto increment */
+    rate?: number;
+    /** Auto-increment frequency in milliseconds */
+    speed?: number;
+}
+/** The use progress return type */
+export interface UseProgressReturn {
+    /** Whether progress is currently active */
+    active: boolean;
+    /** Current progress value in range 0..1, null means hidden */
+    value: number;
+    /** Complete progress to 100% */
+    done: (force?: boolean) => number | null;
+    /** Increment progress with easing behavior */
+    inc: (amount?: number) => number | null;
+    /** Remove progress and stop timers */
+    remove: () => void;
+    /** Start progress and auto incrementing */
+    start: (from?: number | null) => number;
+}
+/**
+ * @name useProgress
+ * @description - Hook that creates a lightweight progress bar
+ * @category Time
+ * @usage medium
+ *
+ * @param {number} [initialProgress] Initial progress value in range 0..1
+ * @param {boolean} [options.active] Controls progress externally (true -> start, false -> done)
+ * @param {number} [options.maximum=0.95] Maximum value when progress starts
+ * @param {number} [options.speed=250] Auto increment interval in milliseconds
+ * @param {number} [options.rate=0.02] Additional random increment amount on each tick
+ * @param {number} [options.delay=250] Delay before reset to null after done
+ * @returns {UseProgressReturn} Current progress state and control methods
+ *
+ * @example
+ * const { value, active, start, done, inc, set, remove } = useProgress(0.2);
+ */
+export declare const useProgress: (initialValue?: number, options?: UseProgressOptions) => {
+    value: number;
+    active: boolean;
+    start: (from?: number) => void;
+    done: () => void;
+    inc: (amount?: number) => void;
+    remove: () => void;
+};

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

@@ -1,10 +1,6 @@
 import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
 export interface UseScrollOptions {
-    /** The on scroll callback */
-    onScroll?: (params: UseScrollCallbackParams, event: Event) => void;
-    /** The on end scroll callback */
-    onStop?: (event: Event) => void;
     /** Offset arrived states by x pixels. */
     offset?: {
         left?: number;
@@ -12,12 +8,12 @@ export interface UseScrollOptions {
         top?: number;
         bottom?: number;
     };
+    /** The on scroll callback */
+    onScroll?: (params: UseScrollCallbackParams, event: Event) => void;
+    /** The on end scroll callback */
+    onStop?: (event: Event) => void;
 }
 export interface UseScrollCallbackParams {
-    /** The element x position */
-    x: number;
-    /** The element y position */
-    y: number;
     /** State of scroll arrived */
     arrived: {
         left: boolean;
@@ -32,6 +28,10 @@ export interface UseScrollCallbackParams {
         top: boolean;
         bottom: boolean;
     };
+    /** The element x position */
+    x: number;
+    /** The element y position */
+    y: number;
 }
 /** The scroll into view params type */
 export interface ScrollIntoViewParams {
@@ -47,16 +47,18 @@ export interface ScrollToParams {
 }
 /** The use scroll return type */
 export interface UseScrollReturn {
-    /** The state of scrolling */
-    scrolling: boolean;
+    /** The latest scroll value snapshot */
+    snapshot: UseScrollCallbackParams;
     /** Function to scroll element into view */
     scrollIntoView: (params?: ScrollIntoViewParams) => void;
     /** Function to scroll element to a specific position */
     scrollTo: (params?: ScrollToParams) => void;
+    /** Function to enable subscriptions and rerender on next updates */
+    watch: () => UseScrollCallbackParams;
 }
 export interface UseScroll {
     (target?: HookTarget, callback?: (params: UseScrollCallbackParams, event: Event) => void): UseScrollReturn;
-    (target?: HookTarget, options?: UseScrollOptions): UseScrollReturn;
+    (target: HookTarget, options?: UseScrollOptions): UseScrollReturn;
     <Target extends Element>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): UseScrollReturn & {
         ref: StateRef<Target>;
     };

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

@@ -11,7 +11,6 @@ export interface UseUrlSearchParamsSetOptions {
 export type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;
 /** The use url search params options type */
 export interface UseUrlSearchParamsOptions<Value> {
-    initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;
     /** The mode to use for writing to the URL */
     mode?: UrlSearchParamsMode;
     /** The mode to use for writing to the URL  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.3.12",
+  "version": "0.3.14",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",
@@ -64,18 +64,19 @@
     "screenfull": "^6.0.2"
   },
   "devDependencies": {
-    "@siberiacancode/vitest": "^2.3.0",
+    "@siberiacancode/vitest": "^2.4.1",
     "@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": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@types/web-bluetooth": "^0.0.21",
-    "@vitejs/plugin-react": "^5.1.3",
+    "@vitejs/plugin-react": "^5.1.4",
     "core-js": "^3.48.0",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
     "shx": "^0.4.0",
+    "tailwindcss": "4.2.1",
     "vite": "^7.3.1",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.0.18"