useMouse
Track and retrieve the position of the mouse cursor with useMouse.
Install:
npm i @uidotdev/usehooks
Description:
The useMouse hook is useful for tracking and retrieving the position of the mouse cursor within a component. By utilizing this hook, developers can easily access information such as the current coordinates of the mouse cursor (x and y), the position of the mouse cursor relative to an element within the component (elementX and elementY), and the position of that element on the page (elementPositionX and elementPositionY).
Parameters
None.
Return Value
The useMouse hook returns an array with two elements:
| Name | Type | Description |
|---|---|---|
state | object | An object representing the current mouse position and element information. |
ref | object | A ref object that can be used to track the mouse position on a specific element. |
The state object has the following properties:
| Name | Type | Description |
|---|---|---|
state.x | number | The current horizontal position of the mouse relative to the page. |
state.y | number | The current vertical position of the mouse relative to the page. |
state.elementX | number | The current horizontal position of the mouse relative to the element’s top-left corner. |
state.elementY | number | The current vertical position of the mouse relative to the element’s top-left corner. |
state.elementPositionX | number | The current horizontal position of the element relative to the page. |
state.elementPositionY | number | The current vertical position of the element relative to the page. |
Demo:
Example:
import * as React from "react";
import { useMouse } from "@uidotdev/usehooks";
import Demo from "./Demo";
export default function App() {
const [mouse, ref] = useMouse();
const xIntersecting = mouse.elementX > 0 && mouse.elementX < 300;
const yIntersecting = mouse.elementY > 0 && mouse.elementY < 300;
const isIntersecting = xIntersecting && yIntersecting;
return (
<section>
<h1>useMouse</h1>
<article
ref={ref}
style={{ width: "300px", height: "300px" }}
className={isIntersecting ? "active" : ""}
>
Use a ref to add coords relative to the element
</article>
<Demo {...mouse} />
</section>
);
}More Hooks:
It’s dangerous to go alone! Master React by learning how to build useHooks yourself.
useDebounce
Delay the execution of function or state update with useDebounce.
useLocalStorage
Store, retrieve, and synchronize data from the browser’s localStorage API with useLocalStorage
useWindowSize
Track the dimensions of the browser window with useWindowSize.
usePrevious
Track the previous value of a variable with usePrevious.
useIntersectionObserver
Track and manage the visibility of your DOM elements within the viewport with useIntersectionObserver.
useNetworkState
Monitor and adapt to network conditions seamlessly with useNetworkState.
useMediaQuery
Subscribe and respond to media query changes with useMediaQuery.
useOrientation
Manage and respond to changes in device orientation with useOrientation.
useSessionStorage
Store, retrieve, and synchronize data from the browser’s session storage with useSessionStorage.
usePreferredLanguage
Adapt to user language preferences dynamically with usePreferredLanguage.
useFetch
Fetch data with accurate states, caching, and no stale responses using useFetch.
useContinuousRetry
Automates retries of a callback function until it succeeds with useContinuousRetry
useVisibilityChange
Track document visibility and respond to changes with useVisibilityChange.
There’s no better way to learn useHooks than by building it yourself.
useScript
Load and manage external JavaScript scripts with useScript.
useRenderInfo
Debug renders and improve performance with useRenderInfo.
useRenderCount
Identify unnecessary re-renders and monitor update frequency with useRenderCount.
useRandomInterval
Execute a callback function at a random interval with useRandomInterval.
useIntervalWhen
Create dynamic timers that can be started, paused, or resumed with useIntervalWhen.
useInterval
Schedule periodic actions like data polling or animations with useInterval.
useLockBodyScroll
Temporarily disable scrolling on the document body with useLockBodyScroll.
useCountdown
Create countdown timers using useCountdown.
useIsClient
Determine whether the code is running on the client-side or server-side with useIsClient.
useQueue
Add, remove, and clear element from a queue data structure with useQueue.
useHover
Track whether an element is being hovered over with useHover.
useTimeout
Create delayed actions or timed events using useTimeout.
Please give us your money.
useEventListener
Listen for events on a target element with useEventListener.
useKeyPress
Detect and perform actions on key press events with useKeyPress.
useMap
Synchronize and update state based on the Map data structure with useMap.
useThrottle
Throttle computationally expensive operations with useThrottle.
useSet
Synchronize and update state based on the Set data structure with useSet.
useCopyToClipboard
Copy text to the clipboard using useCopyToClipboard.
useBattery
Track the battery status of a user’s device with useBattery.
useIdle
Detect user inactivity with useIdle.
useToggle
A hook to toggle a boolean value with useToggle.
useHistoryState
Add undo / redo functionality with useHistoryState.
useGeolocation
Access and monitor a user's geolocation (after they give permission) with useGeolocation.
usePageLeave
Track when a user navigates away from a webpage with usePageLeave.
The all new interactive way to master modern React (for fun and profit).
useObjectState
Manage complex state objects with useObjectState.
useLogger
Debug lifecycle events with useLogger.
useDocumentTitle
Dynamically update the title of a webpage with useDocumentTitle.
useIsFirstRender
Differentiate between the first and subsequent renders with useIsFirstRender.
useLongPress
Enable precise control of long-press interactions for both touch and mouse events with useLongPress.
useFavicon
Dynamically update the favicon with useFavicon.
useDefault
Manage state with default values using useDefault.
useWindowScroll
Track and manipulate the scroll position of a web page with useWindowScroll.
useMeasure
Effortlessly measure and track your component’s dimensions with useMeasure.
useClickAway
Detect clicks outside of specific component with useClickAway.
useList
Manage and manipulate lists with useList.
useCounter
Manage a counter value with minimum and maximum limits with useCounter.