Merge pull request #485 from ArtMedici/main

fix: useMouse Usage example

Author: debabin

packages/core/src/hooks/useMouse/useMouse.ts

@@ -64,15 +64,15 @@ export interface UseMouse {
  * @returns {UseMouseReturn} An object with mouse value controls
  *
  * @example
- * const mouse = useMouse(ref);
+ * const { snapshot, watch } = useMouse(ref);
  *
  * @overload
  * @template Target The target element
  * @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 mouse = useMouse<HTMLDivElement>();
+ * const { ref, snapshot, watch } = useMouse<HTMLDivElement>();
  */
 export const useMouse = ((...params: any[]) => {
   const target = isTarget(params[0]) ? params[0] : undefined;

packages/newdocs/content/functions/hooks/useMouse.mdx

@@ -47,9 +47,9 @@ import metadata from './useMouse.meta.json';
 ## Usage
 
 ```tsx
-const mouse = useMouse(ref);
+const { snapshot, watch } = useMouse(ref);
 // or
-const mouse = useMouse<HTMLDivElement>();
+const { ref, snapshot, watch } = useMouse<HTMLDivElement>();
 ```
 
 ## Type Declarations