element-hover

Track whether the pointer hovers an element.


Package	`@vizejs/composable/element-hover`
Own the source	`vize lib pull composable:element-hover`
Runtime exports	`useElementHover`
Gzip budget	2048 B

Usage

import { useElementHover } from "@vizejs/composable/element-hover";

Runtime contract

Utility	Category	Stability	SSR	Hydration	Cleanup	Targets	Host globals	Uses
`useElementHover`	input	experimental	deterministic-fallback	stable	reactive-scope	web, desktop	`globalThis`	`resolveElement`, `tryOnScopeDispose`

API

`useElementHover`

Track whether the pointer hovers an element. Uses pointerenter/pointerleave (which ignore descendants) with optional enter/leave delays; a pending delay is cancelled by the opposite event. Server renders report false; listeners and timers are released with the owning reactive scope.

function useElementHover( target: MaybeElementTarget, options: UseElementHoverOptions = {}, ): Readonly<Ref<boolean>>

Types

`UseElementHoverOptions`

Options for useElementHover.

Member	Type	Description
`delayEnter`?	`number`	Milliseconds to wait before reporting hover.
`delayLeave`?	`number`	Milliseconds to wait before reporting the end of hover.
`scheduler`?	`TimeoutScheduler`	Owns the delay timer.