Skip to content

useEventListener

用于监听事件的Hook。

基础用法

tsx
import { useEventListener } from 'ono-react-element';

function App() {
    useEventListener(
        'click', // 你想要监听的事件类型
        (e:Event) => { // 事件触发时执行的回调函数
            console.log('点击事件触发了!');
        },{
        target: document.documentElement, // 你想要监听的目标元素
        deps: [] // 依赖项,当依赖项发生变化时,会重新绑定事件监听
    })
}

API

通用属性参考:通用属性

参数说明类型默认值是否必填
event你想要监听的事件类型string-
handler事件触发时执行的回调函数(e:Event) => void-
options监听参数EventListenerOptions-

EventListenerOptions

参数说明类型默认值是否必填
isDeferred是否延迟执行回调函数,值为true时会返回一个函数,可供随时调用booleanfalse
target你想要监听的目标元素Elementwindow
deps依赖项,当依赖项发生变化时,会重新绑定事件监听any[][]