docs: Fix returns values not being Refs

Author: microcipcip

src/components/useClickAway/stories/useClickAway.md

@@ -14,9 +14,9 @@ useClickAway(
 
 ### Parameters
 
-- `elRef: string` the element to check for click away events
-- `onClickAway: string` the callback to run when triggering a click away
-- `events: string` list of events to listen to, defaults to `['mousedown', 'touchstart']`
+- `elRef: Ref<null | Element>` the element to check for click away events
+- `onClickAway: Function` the callback to run when triggering a click away
+- `events: string[]` list of events to listen to, defaults to `['mousedown', 'touchstart']`
 
 ## Usage
 

src/components/useHover/stories/useHover.md

@@ -14,7 +14,7 @@ useHover(elRef: Ref<null | Element>): Ref<boolean>
 
 ### Returns
 
-- `isHovered: boolean` whether the element is currently hovered or not
+- `isHovered: Ref<boolean>` whether the element is currently hovered or not
 
 ## Usage
 

src/components/useMedia/stories/useMedia.md

@@ -18,7 +18,7 @@ useMedia(
 
 ### Returns
 
-- `isQueryMatching: boolean` whether the query matches or not
+- `isQueryMatching: Ref<boolean>` whether the query matches or not
 
 ## Usage
 

src/components/useMouse/stories/useMouse.md

@@ -13,8 +13,8 @@ useMouse(): {
 
 ### Returns
 
-- `docX: number` the mouse `x` position relative to the document
-- `docY: number` the mouse `y` position relative to the document
+- `docX: Ref<number>` the mouse `x` position relative to the document
+- `docY: Ref<number>` the mouse `y` position relative to the document
 
 ## Usage
 

src/components/useMouseElement/stories/useMouseElement.md

@@ -24,14 +24,14 @@ useMouseElement(elRef: Ref<null | Element>): {
 
 ### Returns
 
-- `docX: number` the mouse `x` position relative to the document
-- `docY: number` the mouse `y` position relative to the document
-- `elX: number` the mouse `x` position relative to the given element
-- `elY: number` the mouse `y` position relative to the given element
-- `elInfoX: number` the element `x` position
-- `elInfoY: number` the element `y` position
-- `elInfoW: number` the element `width` value
-- `elInfoH: number` the element `height` value
+- `docX: Ref<number>` the mouse `x` position relative to the document
+- `docY: Ref<number>` the mouse `y` position relative to the document
+- `elX: Ref<number>` the mouse `x` position relative to the given element
+- `elY: Ref<number>` the mouse `y` position relative to the given element
+- `elInfoX: Ref<number>` the element `x` position
+- `elInfoY: Ref<number>` the element `y` position
+- `elInfoW: Ref<number>` the element `width` value
+- `elInfoH: Ref<number>` the element `height` value
 
 ## Usage
 

src/components/useSampleComponent/stories/useSampleComponent.md

@@ -14,7 +14,7 @@ Vue function that...
 
 ### Returns
 
-- `value: string` lorem ipsa
+- `value: Ref<string>` lorem ipsa
 
 ## Usage
 

src/components/useTimeout/stories/useTimeout.md

@@ -23,11 +23,11 @@ useTimeout(
 
 ### Returns
 
-- `isReady: boolean | null` the timer status
+- `isReady: Ref<boolean> | null` the timer status
   - `false` when the timer is executing
   - `true` when the timer is completed
   - `null` when the timer is cancelled
-- `isIdle: boolean` this value is `true` if the timer has ever been called, `false` otherwise
+- `isIdle: Ref<boolean>` this value is `true` if the timer has ever been called, `false` otherwise
 - `cancel: Function` the function used to cancel the timer
 - `start: Function` the function used for starting or resetting the timer
 

src/components/useTimeoutFn/stories/useTimeoutFn.md

@@ -25,11 +25,11 @@ useTimeoutFn(
 
 ### Returns
 
-- `isReady: boolean | null` the timer status
+- `isReady: Ref<boolean> | null` the timer status
   - `false` when the timer is executing 
   - `true` when the timer is completed
   - `null` when the timer is cancelled
-- `isIdle: boolean` this value is `true` if the timer has ever been called, `false` otherwise
+- `isIdle: Ref<boolean>` this value is `true` if the timer has ever been called, `false` otherwise
 - `cancel: Function` the function used to cancel the timer
 - `start: Function` the function used for starting or resetting the timer