useMouse

Reactive mouse position

Demo

This is a .md using a custom component

Basic Usage

x: 0
y: 0
sourceType: null

Extractor Usage

x: 0
y: 0
sourceType: null

Basic Usage

import { useMouse } from './'

const { x, y, sourceType } = useMouse()

Touch is enabled by default. To only detect mouse changes, set touch to false. The dragover event is used to track mouse position while dragging.

import { useMouse } from './'
// ---cut---
const { x, y } = useMouse({ touch: false })

Custom Extractor

It's also possible to provide a custom extractor function to get the position from the event.

import { useMouse, useParentElement } from '@vueuse/core'

const parentEl = useParentElement()

function extractor(event) {
  return event instanceof Touch
    ? null
    : [event.offsetX, event.offsetY]
}

const { x, y, sourceType } = useMouse({ target: parentEl, type: extractor })