useMouse.md

useMouse

Vue function that tracks the mouse x and y position in the document.

Reference

function useMouse(): {
    docX: Ref<number>
    docY: Ref<number>
}

Returns

• docX: Ref<number> the mouse x position relative to the document
• docY: Ref<number> the mouse y position relative to the document

Usage

<template>
  <div>docX docY: {{ docX }}px {{ docY }}px</div>
</template>

<script lang="ts">
  import Vue from 'vue'
  import { useMouse } from 'vue-use-kit'

  export default Vue.extend({
    name: 'useMouseDemo',
    setup() {
      const { docX, docY } = useMouse()
      return { docX, docY }
    }
  })
</script>