VueUseuseElementHover
Reactive element's hover state.
Demo
ReferenceError: window is not defined
Usage
vue
<script setup>
import { useElementHover } from '@vueuse/core'
const myHoverableElement = ref()
const isHovered = useElementHover(myHoverableElement)
</script>
<template>
<button ref="myHoverableElement">
{{ isHovered }}
</button>
</template>
<script setup>
import { useElementHover } from '@vueuse/core'
const myHoverableElement = ref()
const isHovered = useElementHover(myHoverableElement)
</script>
<template>
<button ref="myHoverableElement">
{{ isHovered }}
</button>
</template>
Directive Usage
This function also provides a directive version via the
@vueuse/componentspackage. Learn more about the usage.
html
<script setup lang="ts">
import { ref } from 'vue'
import { vElementHover } from '@vueuse/components'
const isHovered = ref(false)
function onHover(state: boolean) {
isHovered.value = state
}
</script>
<template>
<button v-element-hover="onHover">
{{ isHovered ? 'Thank you!' : 'Hover me' }}
</button>
</template>
<script setup lang="ts">
import { ref } from 'vue'
import { vElementHover } from '@vueuse/components'
const isHovered = ref(false)
function onHover(state: boolean) {
isHovered.value = state
}
</script>
<template>
<button v-element-hover="onHover">
{{ isHovered ? 'Thank you!' : 'Hover me' }}
</button>
</template>
Type Declarations
typescript
export interface UseElementHoverOptions extends ConfigurableWindow {
delayEnter?: number
delayLeave?: number
}
export declare function useElementHover(
el: MaybeComputedRef<EventTarget | null | undefined>,
options?: UseElementHoverOptions
): Ref<boolean>
export interface UseElementHoverOptions extends ConfigurableWindow {
delayEnter?: number
delayLeave?: number
}
export declare function useElementHover(
el: MaybeComputedRef<EventTarget | null | undefined>,
options?: UseElementHoverOptions
): Ref<boolean>
Source
Contributors
Anthony Fu
webfansplz
geekreal
cx33
Joe MaylorChangelog
v9.13.0 on 2/18/2023v9.1.1 on 8/23/2022v8.9.1 on 7/8/2022v8.1.0 on 3/16/2022v8.0.0-beta.1 on 3/5/2022