useElementByPoint

カテゴリ

センサー

エクスポートサイズ

953 B

最終更新日

先週

座標によるリアクティブな要素取得。

デモ

ソースコード

使用方法

import { useElementByPoint, useMouse } from '@vueuse/core'

const { x, y } = useMouse({ type: 'client' })
const { element } = useElementByPoint({ x, y })

型定義

typescript

export interface UseElementByPointOptions<Multiple extends boolean = false>
  extends ConfigurableDocument {
  x: MaybeRefOrGetter<number>
  y: MaybeRefOrGetter<number>
  multiple?: MaybeRefOrGetter<Multiple>
  immediate?: boolean
  interval?: "requestAnimationFrame" | number
}
export interface UseElementByPointReturn<Multiple extends boolean = false>
  extends Pausable {
  isSupported: Ref<boolean>
  element: Ref<Multiple extends true ? HTMLElement[] : HTMLElement | null>
}
/**
 * Reactive element by point.
 *
 * @see https://vueuse.dokyumento.jp/useElementByPoint
 * @param options - UseElementByPointOptions
 */
export declare function useElementByPoint<M extends boolean = false>(
  options: UseElementByPointOptions<M>,
): UseElementByPointReturn<M>