fn
usePointer
v0.0.14testeddemoReactive pointer state (position, pressure, tilt, size, and pointer type) sourced from pointer events on a target, plus whether the pointer is currently inside it.
Examples
ts
const { x, y, pressure, pointerType, isInside } = usePointer();ts
// Track a specific element, pen only
const { x, y, tiltX, tiltY } = usePointer({ target: el, pointerTypes: ['pen'] });Demo
Loading demo…
Signature
ts
export function usePointer(options: UsePointerOptions ={ ... }Parameters
| Parameter | Type | Description |
|---|---|---|
options? | UsePointerOptions | Options |
Returns
UsePointerReturnReactive pointer state refs and isInside| Property | Type | Description |
|---|---|---|
x | WritableComputedRef<number> | — |
y | WritableComputedRef<number> | — |
pressure | WritableComputedRef<number> | — |
pointerId | WritableComputedRef<number> | — |
tiltX | WritableComputedRef<number> | — |
tiltY | WritableComputedRef<number> | — |
width | WritableComputedRef<number> | — |
height | WritableComputedRef<number> | — |
twist | WritableComputedRef<number> | — |
pointerType | WritableComputedRef<UsePointerType | null> | — |
isInside | ShallowRef<boolean> | — |