fn
useMouse
v0.0.15testeddemoReactive mouse (and optionally touch) position with optional custom target, scroll tracking, custom extractors, and event filtering.
Examples
ts
const { x, y, sourceType } = useMouse();ts
// Track relative to an element, throttled
const { x, y } = useMouse({ target: el, eventFilter: throttleFilter(50) });Demo
Loading demo…
Signature
ts
export function useMouse(options: UseMouseOptions ={ ... }Parameters
| Parameter | Type | Description |
|---|---|---|
options? | UseMouseOptions | Options |
Returns
UseMouseReturnReactive `x`, `y`, and `sourceType`