useElementHover

カテゴリ

センサー

エクスポートサイズ

598 B

最終更新日

先週

要素のホバー状態をリアクティブに取得します。

デモ

ソース

使用方法

vue

<script setup>
import { useElementHover } from '@vueuse/core'

const myHoverableElement = ref()
const isHovered = useElementHover(myHoverableElement)
</script>

<template>
  <button ref="myHoverableElement">
    {{ isHovered }}
  </button>
</template>

ディレクティブの使用

この関数は、@vueuse/components パッケージを介してディレクティブバージョンも提供します。使用方法の詳細。

vue

<script setup lang="ts">
import { vElementHover } from '@vueuse/components'
import { ref } from 'vue'

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>

ホバーオプションを提供することもできます

vue

<script setup lang="ts">
import { vElementHover } from '@vueuse/components'
import { ref } from 'vue'

const isHovered = ref(false)
function onHover(hovered: boolean) {
  isHovered.value = hovered
}
</script>

<template>
  <button v-element-hover="[onHover, { delayEnter: 1000 }]">
    <span>{{ isHovered ? 'Thank you!' : 'Hover me' }}</span>
  </button>
</template>

型宣言

typescript

export interface UseElementHoverOptions extends ConfigurableWindow {
  delayEnter?: number
  delayLeave?: number
}
export declare function useElementHover(
  el: MaybeRefOrGetter<EventTarget | null | undefined>,
  options?: UseElementHoverOptions,
): Ref<boolean>