@siberiacancode/reactuse 0.2.30 → 0.2.32

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

@@ -4,8 +4,8 @@ import { StateRef } from '../useRefState/useRefState';
 export interface UseScrollToOptions {
     /** The scrolling behavior */
     behavior?: ScrollBehavior;
-    /** Whether to enable the scroll to */
-    enabled?: boolean;
+    /** Whether to immediately the scroll to */
+    immediately?: boolean;
     /** The horizontal position to scroll to */
     x: number;
     /** The vertical position to scroll to */
@@ -24,7 +24,7 @@ export interface UseScrollTo {
     <Target extends Element>(options?: UseScrollToOptions, target?: never): UseScrollToReturn & {
         ref: StateRef<Target>;
     };
-    (target: HookTarget, options?: UseScrollToOptions): UseScrollToReturn;
+    (target?: HookTarget, options?: UseScrollToOptions): UseScrollToReturn;
 }
 /**
  * @name useScrollTo
@@ -33,8 +33,11 @@ export interface UseScrollTo {
  * @usage low
  *
  * @overload
- * @param {HookTarget} target The target element for scrolling to
- * @param {UseScrollToOptions} [options] The scroll options
+ * @param {HookTarget} [target=window] The target element for scrolling to
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
+ * @param {number} [options.x] The horizontal position to scroll to
+ * @param {number} [options.y] The vertical position to scroll to
+ * @param {ScrollBehavior} [options.behavior=auto] The scrolling behavior
  * @returns {UseScrollToReturn} The scroll trigger function
  *
  * @example
@@ -42,7 +45,10 @@ export interface UseScrollTo {
  *
  * @overload
  * @template Target The target element
- * @param {UseScrollToOptions} [options] The scroll options
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
+ * @param {number} [options.x] The horizontal position to scroll to
+ * @param {number} [options.y] The vertical position to scroll to
+ * @param {ScrollBehavior} [options.behavior=auto] The scrolling behavior
  * @returns {UseScrollToReturn & { ref: StateRef<Target> }} The scroll trigger function and ref
  *
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.2.30",
+  "version": "0.2.32",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",