简体中文

useElementByPoint

Tags:

Element

isSupported

一个用于返回给定点位置上元素的 React Hook。

演示

源码

Supported:

false

isActive:

false

Selected Element:

Mouse Position:

(0, 0)

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

🪝 Hook 🎨 Demo 📄 Document

API

const { isSupported, element, ...controls } = useElementByPoint(options)

选项 Options

export type UseElementByPointOptions<M extends boolean = false> = Position & {
  /**
   * 是否返回多个元素
   *
   * @defaultValue false
   */
  multiple?: M
  /**
   * 是否立即执行
   *
   * @defaultValue true
   */
  immediate?: boolean
  /**
   * 执行的间隔
   *
   * @defaultValue 'requestAnimationFrame'
   */
  interval?: 'requestAnimationFrame' | number
}

返回值

返回值中包含可暂停、恢复的 Pausable 实例。

更多详情，请参见 Pausable。

export type UseElementByPointReturns<E extends Element | null | Element[]> = Pausable & {
  /**
   * 浏览器是否支持该 API
   */
  isSupported: boolean
  /**
   * 指定位置上的元素
   */
  element: E
}

ON THIS PAGE

#useElementByPoint

#演示

#用法

#源码

#API

#选项 Options

#返回值

useElementByPoint

演示

用法

源码

API

选项 Options

返回值