Skip to content

useMouseInElement ​

Category
Export Size
1.12 kB
Last Changed
8 months ago

Reactive mouse position related to an element

Demo ​

Hover me
x: 0
y: 0
sourceType: null
elementX: 0
elementY: 0
elementPositionX: 0
elementPositionY: 0
elementHeight: 0
elementWidth: 0
isOutside: true

Usage ​

html
<template>
  <div ref="target">
    <h1>Hello world</h1>
  </div>
</template>

<script>
import { ref } from 'vue'
import { useMouseInElement } from '@vueuse/core'

export default {
  setup() {
    const target = ref(null)

    const { x, y, isOutside } = useMouseInElement(target)

    return { x, y, isOutside }
  }
}
</script>
<template>
  <div ref="target">
    <h1>Hello world</h1>
  </div>
</template>

<script>
import { ref } from 'vue'
import { useMouseInElement } from '@vueuse/core'

export default {
  setup() {
    const target = ref(null)

    const { x, y, isOutside } = useMouseInElement(target)

    return { x, y, isOutside }
  }
}
</script>

Component Usage ​

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

html
<UseMouseInElement v-slot="{ elementX, elementY, isOutside }">
  x: {{ elementX }}
  y: {{ elementY }}
  Is Outside: {{ isOutside }}
</UseMouseInElement>
<UseMouseInElement v-slot="{ elementX, elementY, isOutside }">
  x: {{ elementX }}
  y: {{ elementY }}
  Is Outside: {{ isOutside }}
</UseMouseInElement>

Source ​

Source • Demo • Docs

Contributors ​

Anthony Fu
wheat
Mikhailov Nikita
vaakian X
Jelf
Ivan Agafonov
Shinigami
Alex Kozack
ctholho
Nurettin Kaya
Antério Vieira

Changelog ​

v9.12.0 on 1/29/2023
54f4e - fix: check if mouse out of window (#2458)
v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)
v8.9.3 on 7/14/2022
4d2c8 - fix(useMouse)!: rename type MouseOptions to UseMouseOptions (#1877)
v8.6.0 on 5/31/2022
ebd60 - fix isOutside is true for detached elements (#1614) (#1615)

Released under the MIT License.