packages/core/useMouseInElement/index.md
Reactive mouse position related to an element
<script setup lang="ts">
import { useMouseInElement } from '@vueuse/core'
import { useTemplateRef } from 'vue'
const target = useTemplateRef('target')
const { x, y, isOutside } = useMouseInElement(target)
</script>
<template>
<div ref="target">
<h1>Hello world</h1>
</div>
</template>
<template>
<UseMouseInElement v-slot="{ elementX, elementY, isOutside }">
x: {{ elementX }}
y: {{ elementY }}
Is Outside: {{ isOutside }}
</UseMouseInElement>
</template>
<script setup lang="ts">
import { vMouseInElement } from '@vueuse/components'
import { UseMouseSourceType } from '@vueuse/core'
interface MouseInElementType {
x: number
y: number
sourceType: UseMouseSourceType
elementX: number
elementY: number
elementPositionX: number
elementPositionY: number
elementHeight: number
elementWidth: number
isOutside: boolean
}
const options = {
handleOutside: true
}
function onMouseInElement({ x, y, sourceType, elementX, elementY, elementPositionX, elementPositionY, elementHeight, elementWidth, isOutside }: MouseInElementType) {
console.log(x, y, sourceType, elementX, elementY, elementPositionX, elementPositionY, elementHeight, elementWidth, isOutside)
}
</script>
<template>
<textarea v-mouse-in-element="onMouseInElement" />
<!-- with options -->
<textarea v-mouse-in-element="[onMouseInElement, options]" />
</template>