Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(useElementHover): introduce delay hooks #2741

Merged
merged 4 commits into from
Feb 18, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 5 additions & 8 deletions packages/core/useElementHover/index.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
import type { Ref } from 'vue-demi'
import { computed, ref } from 'vue-demi'
import { ref } from 'vue-demi'
import type { MaybeComputedRef } from '@vueuse/shared/utils/types'
antfu marked this conversation as resolved.
Show resolved Hide resolved
import { useEventListener } from '../useEventListener'
import type { MaybeElementRef } from '../unrefElement'
import { unrefElement } from '../unrefElement'
import type { ConfigurableWindow } from '../_configurable'

export interface UseElementHoverOptions extends ConfigurableWindow {
delayEnter?: number
delayLeave?: number
}

export function useElementHover(el: MaybeElementRef, options: UseElementHoverOptions = {}): Ref<boolean> {
export function useElementHover(el: MaybeComputedRef<EventTarget | null | undefined>, options: UseElementHoverOptions = {}): Ref<boolean> {
const delayEnter = options ? options.delayEnter : 0
const delayLeave = options ? options.delayLeave : 0
const isHovered = ref(false)
Expand All @@ -29,10 +28,8 @@ export function useElementHover(el: MaybeElementRef, options: UseElementHoverOpt
if (!window)
return isHovered

const target = computed(() => unrefElement(el))

useEventListener(target, 'mouseenter', () => toggle(true), { passive: true })
useEventListener(target, 'mouseleave', () => toggle(false), { passive: true })
useEventListener(el, 'mouseenter', () => toggle(true), { passive: true })
useEventListener(el, 'mouseleave', () => toggle(false), { passive: true })

return isHovered
}